python-sphinx

0熱度

2回答

我需要一個PHP項目的文檔系統，我希望它能夠將代碼註釋中生成的文檔與外部文檔（用例，項目範圍等）集成在一起。似乎phpDocumentor具有完全正確的功能集，但外部文檔必須用DocBook編寫，這對於我們的團隊來說太複雜了。如果是在Python中，獅身人面像將是完美的工作（ReST肯定比docbook簡單）。有什麼方法可以將外部ReST文檔與從phpdoc中提取的文檔進行整合？我應該分開外部文

1熱度

1回答

獅身人面像0.6.3：這些語言模塊無法找到

我收到以下錯誤消息時我嘗試使用獅身人面像，快速入門產生MAKE.BAT命令：將HTML Error: The languages module cannot be found. Did you install Sphinx and its dependencies correctly? 我試着運行sphinx-build命令並收到相同的錯誤。我在Windows Vista上使用Python 2

4熱度

1回答

警告/警告/通知中的圖像

我目前使用Sphinx來生成LaTeX輸出，該輸出使用pdftex轉換成書籍式輸出的PDF。目前，我有通知，警告，和其他「告誡」呈現出界方框內了，在那看起來有點像這樣的風格： ----------------------------------- | Warning: lorem ipsum foozle | | fuzzle fuzz buzz | |--------------

3熱度

1回答

如何讓Sphinx測試嵌入在文檔中的代碼？

如果此代碼在我的文檔中是一個塊引用，那麼在生成文檔時，我需要做些什麼才能使Sphinx運行它？我嘗試添加 .. testcode:: import datetime def today(): return datetime.datetime.now().date() if True: today() 到的.rst來源和獅身人面像的doct

5熱度

3回答

強制打開某些蛋目錄

我有一個PyQt應用程序的蛋發行，我自己構建，它包含獅身人面像生成的文檔。當我從應用程序調用幫助文件時，它會在QtWebKit.QWebView窗口中打開sphinx index.html。顯然，只有index.html文件是從egg中提取到操作系統的egg目錄（例如Windows下的[..] \ Application Data \ Python-Eggs \）。這會導致css破碎，圖像斷開和

18熱度

8回答

一些很好的獅身人面像定製的例子？

我使用sphinx-quickstart創建了一個Sphinx文檔。是否有任何關於自定義外觀的好示例/教程？特別要修改標題並添加徽標。是否有一些可下載的Sphinx文檔的項目？我想看看他們是如何定製他們的外觀。更新：添加標誌的默認設置是支持，只是不是特別有據可查。在conf.py中查看*_logo設置.`

5熱度

2回答

獅身人面像 - 生成Trac門票和變更集的自動引用

是Sphinx，有沒有辦法將#112或r1023這樣的文本自動鏈接到Trac中對應的門票/變更集？對於如： #112 -> http://mytracsite/tickets/112 r1023 -> http://mytracsite/changeset/1023 更多的例子見TracLinks。

1熱度

2回答

在python sphinx文檔中記錄模塊/類/函數體

有沒有一種方法可以讓Sphinx文檔使用autodoc功能輸出函數或類體（代碼本身）？我使用autodoc取得了很大的成功。除了docstrings被拉到文檔我想要一個鏈接點擊每個功能，它會告訴你來源......這是可能的嗎？這是什麼我的大多數文件看起來像現在： .. module:`foo.mymodule` Title ===================

3熱度

1回答

有人從螞蟻跑獅身人面像？

我對某些軟件文檔使用sphinx，因爲它似乎工作得很好......但我的項目是一個java項目，我想從一個ant腳本運行sphinx。有沒有人寫過一個自定義的ant任務來調用sphinx？

6熱度

1回答

如何讓Sphinx的inheritance_diagram可讀？

到this chap's post類似，我看到獅身人面像的產生不可讀的graphviz輸出：我怎麼能產生可讀的輸出？如果我添加-Gfontsize=140 如果我告訴它使用的neato代替dot它產生可讀的輸出，但圖不樹狀沒有任何反應。