Python 找不到 Sphinx 模塊

[英]Python Sphinx Module Not Found

我有一個子項目，我想用 python 獅身人面像來記錄。 它的結構是這樣的： 來自 extraction_model 的文檔沒有任何問題。 但是現在，如果我嘗試記錄 ocr 部分，我總是會收到警告： 我真的不明白為什么，因為兩者都在同一個目錄中。 helperfunc 以這種方式導入： 第一個是 ...

Sphinx：從 C 中實現的基類繼承的類的 Autodocs

[英]Sphinx: Autodocs for classes inheriting from base classes implemented in C

從collections.deque繼承時，我遇到了錯誤/警告。 獅身人面像抱怨： 對於這個例子， utils.py只包含from collections import deque class Test(deque): pass 我最好的猜測是，這可能是由在 C 中實現的deque引起 ...

Sphinx Autosummary (Autodoc) 部分導入模塊

[英]Sphinx Autosummary (Autodoc) partially imports modules

Sphinx autosummary/autodoc 給出了一些模塊的錯誤，但不是全部。 我的代碼是開源的： https://github.com/dream-faster/krisi 我收到以下錯誤： 它導入了一些模塊（例如： compare.py ）但無法導入其他模塊（無論它們位於哪個子目錄中 ...

使用 Sphinx 為多個文件夾生成文檔

[英]Generating documentation for multiple folders with Sphinx

我目前正在從事一個 Python 項目，該項目的增長超出預期。 我的代碼在整個文檔字符串中都有記錄，現在我想用 Sphinx 生成一個全面的文檔。 但是，無論我嘗試什么，我都無法找到一種在單個命令中生成所有內容的方法。 這是我的項目的更新結構： 理想情況下，我想要一個遵循此結構的 HTML 文檔。 ...

Sphinx autodoc：顯示繼承全名

[英]Sphinx autodoc : show-inheritance full name

我有一個模塊層次結構，其中包含彼此子類化的同名類，例如# foo.py class Box: ... # bar.py class Box: ... # foobar.py import foo, bar class Box(foo.Box, bar.Box): ... 我的課程模板設置為objn ...

Python 文檔字符串損壞，首先需要參數

[英]Python docstrings broken, requires parameter first

我將 python 的文檔字符串與 Sphinx Autodoc/Napoleon 結合使用時出現了一個奇怪的錯誤： 使用文檔字符串時，只要我將注釋放在參數上方，格式就會被破壞。 當我將文本放在參數之后（與 pythons 以文檔字符串生成格式構建相反）時，它起作用了： （查看結果的屏幕截圖）。 ...

Python 獅身人面像的路徑問題？

[英]Python Path Issues with Sphinx?

我在嘗試將 Sphinx 自動文檔用於 python package 時遇到了很多麻煩，我認為問題是一個路徑，但我不知道如何解決？ 想知道有沒有人知道？ 我正在嘗試一個超級基本的模塊設置，在“my_project”內部有一個 main.py，如下所示： 在以下兩種情況下，我只有一個基本的 con ...

從需求庫的 init 中讀取文檔 ModuleNotFoundError

[英]Readthedocs ModuleNotFoundError from the init in a requirements library

我想知道是否有人可以幫助我解決這個問題： 我正在嘗試將我的庫文檔上傳到 readthedocs。 sphinx 文檔在我的計算機上完全編譯。 但是，在 readthedocs 儀表板上構建失敗。 這是錯誤： 如果我正確理解了這個問題，我的一個需求庫（pyneb）找不到我的另一個需求庫（numpy ...

控制 sphinx generated.rst 文件的保存位置

[英]Controlling where sphinx generated .rst files are saved

賞金將在 3 天后到期。 此問題的答案有資格獲得+50聲望賞金。 Mathieu希望引起對這個問題的更多關注。 假設 sphinx 的文檔結構如下： 並且classes.rst 、 functions.rst和more_functions.rst具有使用autodoc/autosummary自動 ...

獅身人面像包括私有屬性，即使沒有指示

[英]Sphinx includes private attributes even though not instructed to

我沒有在任何地方包含:private-members:選項，但 Sphinx 仍然在該類的文檔中包含私有屬性。 我究竟做錯了什么？ MWE： mypackage/foo.py ： class MyClass(object): """A class. Attributes ...

在 Sphinx 的模塊頁面頂部生成函數列表

[英]generate list of functions at top of module page in Sphinx

我覺得這應該很簡單，但經過數小時的試驗/搜索，我無處可去。 我在一個名為mypackage的包中有一個模塊foo.py ： def foo1(bar1, bar2): """foo some bars Parameters ---------- bar1 : ba ...

如何從 Sphinx 自動類輸出中刪除“參數”部分

[英]How to remove the "Parameters" section from Sphinx autoclass output

使用autoclass記錄數據類時，您會在類文檔字符串之后獲得“參數”部分。 你怎么能去掉這個？ 這是我想要實現的視覺效果： 編輯：這是示例中的類定義： class Dense(Module): """A linear transformation applied over the las ...

上傳到 Github 后，Sphinx 文檔（autodoc）無法正常工作

[英]Sphinx Documentation (autodoc) not working after uploading to Github

我已經為我的包構建了 sphinx 文檔。 測試本地主機時它工作正常。 但是在將其上傳到Github並在 readthedocs.org 上構建文檔后，使用readthedocs.org的文檔頁面無法正常工作。 這是 Github 存儲庫的鏈接。 https://github.com/Spark ...

拿破侖過度轉義參數名稱中的尾隨下划線導致未知目標名稱錯誤

[英]Napoleon overescapes trailing underscore in parameter name leading to Unknown target name error

我現在正好遇到了本期中描述的問題： https://github.com/sphinx-doc/sphinx/issues/7734 。 該期還提供了一個 MWE。 我的問題只是默認情況下似乎沒有激活修復程序。 在源代碼中，我發現配置中名為strip_signature_backslash的設置必須 ...

autodoc：“無法導入模塊”時的解決方法

[英]autodoc: workaround when "cannot import module"

我想用 Sphinx 記錄的包包含純 Python 模塊（好的）+ 使用 pybind11 綁定的 C/C++ 庫。 有很多依賴項無法合理地建立在 ReadTheDocs 上！ 所以在 RTD 上， autodoc無法導入我的庫來提取文檔字符串...... 我的第一個想法是在本地生成_build ...

autodoc_pydantic：顯示來自父模型的字段

[英]autodoc_pydantic: Show fields from parent model

我正在使用 Sphinx 的autodoc_pydantic插件來記錄我的pydantic.BaseModel類。 但是，在某些情況下，我有類似的東西 class Foo(pydantic.BaseModel): '''Foo class''' x: str = pydantic. ...

Autodoc 因具有嵌套 pydantic 模型的類而失敗

[英]Autodoc failing with class that has nested pydantic model

作為我的 MRE，我有以下文件： 廢話 '''Blah module''' import pydantic class Foo: '''Foo class''' class Bar(pydantic.BaseModel): '''Bar class''' ...

Sphinx“autodoc”擴展甚至無法找到保證存在的標准模塊

[英]Sphinx "autodoc" extension unable to even find standard modules guaranteed to exist

我正在嘗試記錄 beartype 的 public API，它是beartype的一個有趣的運行時類型檢查器。 我徹底失敗了。 Sphinx 的autodoc擴展無法找到標准的純 Python CPython 模塊，這些模塊既保證存在又可以簡單地導入。 這不應該是……但它是。 因此，這個問題與關於 ...

如何讓 sphinx 為記錄的參數指定完整的模塊路徑？

[英]How to make sphinx specify full module path for documented parameters?

我正在使用 sphinx 來自動記錄一個類。 構造函數看起來像這樣： from PyQt6.QtCore import QEasingCurve class MyClass: def __init__(animationType=QEasingCurve.Type.OutCubic): ...

Function 在 Sphinx autodoc 生成的文檔中出現兩次

[英]Function appears two times in Sphinx autodoc generated documentation

背景資料我通過 Sphinx autodoc 從文檔字符串生成文檔。 源文件mypackage/mypackage.py中有一個 function mypackage.mypackage.foo() 。 它在__init__.py中隱式導入，因此用戶可以將其用作mypackage.foo() 。 我 ...