python-sphinx

71熱度

3回答

如何使用Sphinx的autodoc來記錄類的__init __（self）方法？

默認情況下，Sphinx不會爲__init __（self）生成文檔。我曾嘗試以下： .. automodule:: mymodule :members: 和 ..autoclass:: MyClass :members: 在conf.py，設置以下僅追加__init __（個體經營）文檔字符串類的文檔字符串（the Sphinx autodoc documentati

3熱度

1回答

獅身人面像，buildbot（和代碼覆蓋率）。他們如何整合？

我有一個不是很小的python包，有很多歷史記錄，都有docstrings。在開發過程中，我們引入了buildbot以及後來的Jenkins/Hudson。最近，我爲buildbot.cfg添加了sphinx配方，以便收集來源的文檔並保持最新的可訪問文檔。到目前爲止，這麼好：我每次提交更改時，Jenkins會全面檢查軟件包，生成非常完整的概覽並更新我們的文檔網站。我啓用的一個獅身人面像擴展：c

0熱度

1回答

sphinx autodoc help

試圖使用sphinx的autdoc擴展，但它不工作。我在djano項目文件夾中保存了「docs」文件夾。它沒有爲我的模塊生成文檔。另外我不確定自動待辦事項是如何工作的。

49熱度

4回答

在reStructuredText鏈接中設置文本格式

如何設置reStructuredText中指定鏈接的文本格式？具體來說，我想從我的第一個生成以下HTML： <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 結果應該是這樣的： optparse.Option

6熱度

3回答

如何從python生成reST/sphinx源代碼？

我想通過reST生成文檔，但不想手動編寫reST源代碼，但讓python腳本執行該操作，然後使用sphinx生成其他格式（HTML，PDF）。想象一下，我有一個二進制格式的電話簿。現在我用一個python腳本解析這個併產生所有的名字和號碼的文檔： phone_book = PhonebookParser("somefile.bin") restdoc = restProducer.N

10熱度

1回答

是否有可能重寫特定功能的獅身人面像autodoc？

我正在使用Sphinx的autodoc插件來自動記錄一組模塊。我有一個接受*args的函數，我想覆蓋文檔以顯示Python stdlib文檔使用的略微好看的funcname(arg1[, arg2[, ...]])樣式。是否有可能覆蓋特定功能的autodoc輸出？

18熱度

1回答

sphinx自定義的latexpdf輸出？

只是好奇，如果有人知道如何定製使用latexpdf目標時的獅身人面像輸出？我已經看到很多html輸出的自定義東西，但似乎找不到任何自定義PDF輸出的例子。具體來說，我有興趣定製標題頁，頁眉，頁腳，並可能在內容前添加前幾頁的內容。有沒有人看到過這種定製的任何例子，或者幾乎所有人在生成pdf時都使用「stock」獅身人面像輸出？謝謝！

32熱度

1回答

Sphinx文檔：從生成的PDF中刪除空白頁面？

默認情況下，Sphinx文檔輸出格式化爲雙面打印的PDF。因此，在標題頁面和目錄，TOC和介紹，介紹和第一部分之間有一個空白頁面。我的用戶總是會在線查看PDF。所以我想刪除這些空白頁面。這似乎是獅身人面像中一個棘手的問題。 See this email thread。 This user提出了兩種解決方案，但都不適用於我。奇怪的是，第一個解決方案： latex_elements = {

1熱度

1回答

同時使用多個獅身人面像主題

我想在獅身人面像中使用多個主題 - 這樣一個頁面有一個主題，第二個頁面有第二個主題。在我看來，只能同時設定一個主題 - 這是真的嗎？非常感謝，斯內德

59熱度

2回答

如何在reStructuredText中創建嵌套列表？

我試圖創建使用下面的代碼正確嵌套表（以下Sphinx和docutils文檔）： 1. X a. U b. V c. W 2. Y 3. Z 我預計這將導致兩個OL秒，但我得到以下輸出，而不是： <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <