python-sphinx

2熱度

1回答

我使用Sphinx來記錄Python模塊。我有一個主目錄doc，我在其中將個別*.rst文件（對於每個模塊組件）都包含在index.rst主文件中。這很好（請檢查source of the Python Library Reference，看看我是如何做到的）。我的問題是當我需要爲給定的模塊組件（而不是整個模塊）創建一個獨立的PDF。假設您具有與完整模塊（庫）中的Python Library

3熱度

4回答

我該如何擺脫獅身人面像乳膠輸出的頁眉中的「第1版」？

我正在使用Sphinx的「手動」文檔類，我很滿意乳膠輸出如何，除了頁眉。它包含我的論文的標題以及「第1版」。因爲我正在寫一篇文章而不是文檔，所以我顯然不需要發佈信息。不幸的是，很難找到關於如何定製Sphinx膠乳輸出的信息。有人知道該怎麼做嗎？

3熱度

3回答

Django templatetags上的獅身人面像文檔

我使用Sphinx和autodoc來記錄我的Django項目。設計人員想要擁有關於項目中定義的所有模板標籤的文檔頁面。當然，我可以通過手工列舉所有模板處理函數來製作這樣的頁面，但我認爲它不是乾的，不是嗎？實際上，模板標籤處理函數全部用@register.inclusion_tag裝飾器標記。因此，對於一些例行程序來說，將它們全部收集並放入文檔似乎是可能的和自然的。與過濾功能相同。我已經使用它

4熱度

4回答

sphinx.ext.pngmath當我嘗試一個簡單的表達時產生一個錯誤

我使用Sphinx來創建我的項目的文檔。我想使用擴展sphinx.ext.pngmath和與這個小測試： Returns the indefinite integral of the polynomial *poly*: .. math:: \int p(x)dx 我得到了錯誤： WARNING: inline latex u'\\int p(x)dx\n\n': lat

10熱度

1回答

在我的Sphinx文檔中包含PDF的最佳方式是什麼？

我有一個PDF格式的文件，它有一些我深入解釋的Sphinx文檔中的例子。有沒有辦法輕鬆地將PDF包含在我的項目中（並在構建文檔時將其複製）？我試着用：doc連接到它：但是這並沒有複製它。

22熱度

5回答

Python獅身人面像autodoc和裝飾成員

我試圖使用獅身人面像來記錄我的Python類。我可能會使用車博士： .. autoclass:: Bus :members: 雖然正確地讀取了我的方法的文檔字符串，那些裝飾： @checkStale def open(self): """ Some docs. """ # Code 與@checkStale是 def ch

16熱度

3回答

sphinx，restructuredtext：爲單個單詞設置顏色

有沒有辦法設置sphinx中的單個單詞（或字符）的顏色？我很確定應該有一些標記標記，比如HTML的font標記。

2熱度

1回答

html中的雙向性

使用Sphinx，我在編輯pylearn文檔內容https://bitbucket.org/omidraha/pylearn/。所有段落都是從右到左（由於波斯語言）以及文本之間的代碼示例，渲染不正確。通常我正在尋找一種方法來在網頁上應用unicode或microsoft的雙向性算法。有沒有辦法將css樣式的代碼設置爲RTL段落內的LTR？如果沒有，我怎麼能修改獅身人面像源來做單獨的代碼示例，

27熱度

2回答

將Sphinx autodoc-skip-member連接到我的函數

我想使用sphinx's autodoc-skip-member事件來選擇某個python類的成員的一部分作爲文檔。但是從獅身人面像文檔中並不清楚，我找不到任何示例說明：我在哪裏將代碼連接到此？我看到Sphinx.connect，我懷疑它會在我的conf.py，但是當我嘗試在conf.py這個代碼的變化我無法找到我應該connect（）的應用程序對象： def maybe_skip_member

8熱度

1回答

在獅身人面像中，我如何創建可鏈接的「術語」部分而沒有大量開銷？

我想創建一個「術語」部分，其中包含我正在使用的術語的定義，以便每次使用此術語部分中的術語時，都會創建一個指向該定義的鏈接。目前，我能想起來的最好的是： .. |flavor| replace:: `:ref:flavor` .. _flavor: flavor ------ blah blah blah 後來的後來，在其他文本我必須做的： ''' This is a usage