python-sphinx

1熱度

1回答

我得到了如何使用numpy docstrings來記錄單個類和方法等，但我也希望有一個頁面顯示用戶如何在我們的設施環境中使用我的包（例如，如何訪問Jupyter筆記本，如何加載我的軟件包，如何設置環境以及如何在實踐中使用它）。有沒有辦法直接在Sphinx中做到這一點？或者我需要使用另一個程序構建HTML頁面？

6熱度

2回答

如何在代碼塊中包含內部引用？

以我斯芬克斯.rst文件我有一個包含使用UNIX tree命令我的產品的結構的樹視圖代碼塊： |── parent | |── child | |── grandchild 這是一個在一個碼塊，使得斯芬克斯保留空格。我希望讀者能夠點擊每個節點，按照internal hyperlink來描述該節點的文檔部分。但是，在代碼塊中添加:ref:不起作用（請參見下文）。有

3熱度

1回答

如何在sphinx項目中正確包含其他ReST文件？

我的手寫文檔/用戶指南（用Sphinx編寫在ReStructuredText中）已經變得相當大，所以我開始在子目錄中組織我的.rst文件。在index.rst我包括每個子目錄的subindex.rst，其本身包括其他.rst文件的其他子目錄。 index.rst： .. include:: subdir1/subindex.rst .. include:: subdir2/subindex.r

2熱度

1回答

谷歌樣式文檔字符串示例部分不作爲代碼片段呈現

我最近開始向我的項目添加文檔，並試圖遵循Google樣式指南。我使用Sphinx生成文檔和Sphinx擴展拿破崙，以填補Google styleguide和reST之間的差距。我沒有問題渲染參數和註釋，但我似乎無法得到示例部分來呈現代碼段。 class Chicken(object): """Animal that lays egg and has feathers N

1熱度

1回答

在同一函數中記錄不同的參數可能性

我使用Google風格的文檔字符串與sphinx.ext.autodoc自動生成我的函數的文檔，並確保它們在代碼中正確自我記錄。我有一個函數def myfunc(id=None, size=None, hash=None)，基於id或size + hash返回信息。如果我們有id作爲參數，則不需要size和hash，如果我們有size和hash作爲參數，則不需要id。使用sphinx，可以指定

0熱度

1回答

獅身人面像HTML變量

我想在conf.py一個變量插入是一個字符串加一個鏈接： rst_epilog = """ .. |support| replace:: `support team <[email protected]>`_ """ 在這種情況下「支持團隊」會變成指向一個鏈接電子郵件地址。不幸的是，這不起作用，構建中斷。所以我試着在那裏轉儲HTML，不知道何時發生替換，但它發生在HTML轉換之前，所以

2熱度

1回答

獅身人面像警告：x源文件已過期的目標

我有一個使用獅身人面像引導主題的基於獅身人面像的網站。每當我在裏面添加一個RST文件，並通過鍵入make html運行時，它總是給人這樣的警告： building [html]: targets for 6 source files that are out of date 構建是成功的，但我想，以防止此警告出現在所有的時間。它計算我添加的RST文件的數量。順便說一下，我使用：orphan：在

0熱度

1回答

由導航欄遮擋的內部參照目標

我在Sphinx文檔中廣泛使用了internal references，以便於瀏覽。雖然參考文件工作正常，但我注意到它們不會將讀者帶到目標頁面上的正確位置，因爲它被導航欄遮擋了。點擊後，我的:ref:下面的章節：正如你：點擊我的:ref:下面章與導航欄隱藏後可以看到，當導航欄被隱藏時，它會將讀者帶到正確的位置（標題在to處）頁面的p）。我使用的獅身人面像引導主題，但我也注意到，這個問題出

0熱度

1回答

獅身人面像正在緩存python模塊：WHERE？

我正在嘗試使用Sphinx爲python模塊創建簡單的文檔。我第一次運行它，它運行良好。現在，我已經做了一些更新的模塊，並重新運行命令文件： $ sphinx-apidoc -P -F -f -e -o . /path/to/module $ make html 它總是使用舊版本的Python模塊代碼。我試圖刪除整個文檔目錄，移動模塊，重新檢查它，更新sphinx - 沒有任何工作。舊代碼仍在重

2熱度

1回答

使用Sphinx autodoc文檔Flask應用程序

我在使用Sphinx生成Flask應用程序的文檔時遇到問題。沒有進入應用程序的具體細節，其基本結構如下所示。 __all__ = ['APP'] <python 2 imports> <flask imports> <custom imports> APP = None # module-level variable to store the Flask app <other