標簽[sphinx-napoleon] - 堆棧內存溢出

[英]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的設置必須 ...

Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention

[英]Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention

我正在使用帶有拿破侖擴展名的 Sphinx 4.4.0 (Google Doc String)。我有這兩個問題ARNING: Block quote ends without a blank line; unexpected unindent. ERROR: Unexpected indenta ...

Sphinx autodoc/napoleon 不生成文檔字符串

[英]Sphinx autodoc/napoleon doesn't generate docstrings

我正在做一個非常簡單的示例，但無法使其正常工作。我只有一個文件， simulator.py ，我在其中添加了 numpy 樣式的文檔字符串。它不導入任何其他庫。它有一個__init__ ，我可以從 python 解釋器中導入它。我的目錄結構如下：我正在使用 sphinx-build 4.0 ...

文檔中的變量格式更改為 ~class.attribute

[英]Variable format changed to ~class.attribute in docs

所以我已經在一些文檔上工作了幾個星期，直到昨晚，它們總是看起來很好，所有變量都開始以~Class.Attribute格式出現。我試圖回滾到以前工作的多個版本，但它們都顯示這樣的變量。有沒有什么我想得到的東西只顯示沒有〜Class的屬性名稱~Class. .class Certificatio ...

您如何為 sphinx autodoc 定義自己的 Z25F7E525B5C0641E1EB1FB3BDEBEB15B5Z 序言？

[英]How do you define your own latex preamble for sphinx autodoc?

我想使用 latex algpseudocode package 將算法添加到我的文檔字符串中。我還希望能夠定義用戶宏來加快我在文檔字符串中輸入數學方程式的速度。我正在使用帶有 sphinx 的拿破侖自動文檔樣式從我的文檔字符串中生成文檔。 ...

在沒有警告的情況下在拿破侖中使用類數組作為類型

[英]Using array-like as a type in napoleon without warning

我有一個項目，其中一些功能記錄在拿破侖 numpy 風格中。本着 numpyness 的精神，我有一堆 function arguments ，它們屬於 class array-like 。這是一個例子：這工作得很好，並且類型包含在 output 中，沒有鏈接：問題是我在每個 functi ...

sphinx 警告：自動摘要：未找到 class 方法的存根文件。檢查您的 autosummary_generate 設置

[英]sphinx warning: autosummary: stub file not found for the methods of the class. check your autosummary_generate settings

我有一個開源 package，在不同的子模塊上有很多類。所有類都有方法fit和transform ，並從 sklearn 繼承fit_transform 。所有類都有跟隨 numpydoc 的文檔字符串，帶有子標題參數、屬性、注釋、另見和方法，其中我列出了fit 、 transform和fit_ ...

在 Python 中記錄類級變量

[英]Documenting class-level variables in Python

我試圖記錄一個 Python class 有一些類級成員變量，但我無法使用 reST/Sphinx 適當地記錄它。代碼是這樣的：class OSM: """Some blah and examples""" url = 'http://overpass-api.de/api/int ...

使用 Python Sphinx 向模塊文檔字符串添加參數

[英]Adding parameters to module docstrings with Python Sphinx

我在每個模塊的開頭都有一個文檔字符串來描述它的用法和功能。在這里，我還想添加最相關的參數 - 如參數文件中的設置或通過命令行參數。它不是經典的函數參數，因為模塊也可能被稱為獨立的（通過if __name__ == '__main__'捕獲）。但是由於 Sphinx 的普通參數格式很整潔，我只想 ...

拿破侖和 autodoc 如何交互記錄成員

[英]How napoleon and autodoc interact documenting members

我注意到 Sphinx 呈現類描述的行為發生了變化。鑒於此代碼 # my example happens to be a dataclass, but the behavior for # regular classes is the same @dataclass class TestClas ...

跳過文檔中的類型提示

[英]Skipping type hints in documentation

讓我們考慮以下 function：def f(x: int, y: int) -> int: """Get sum of two integers. Parameters ---------- x : int first integer ...

是否有使用 sphinx.ext.napoleon 在 Sphinx 中記錄函數類型參數的標准格式？

[英]Is there a standard format for documenting function-type parameters in Sphinx using sphinx.ext.napoleon?

我正在使用 Sphinx 來記錄我的一個項目，其中一個類將 function 作為其__init__中的參數。是否有標准方法來記錄此函數類型參數？我還使用sphinx.ext.napoleon為我的文檔字符串使用 Google 格式。這是一個例子：class ExampleClass: ...

使用拿破侖預處理器在獅身人面像中插入圖像

[英]Insert image in sphinx using napoleon pre-processor

使用 sphinx 3.1.1，我想使用拿破侖預處理器插入圖像。似乎通過在文檔字符串中使用命令：“.. image::”，它可以防止使用拿破侖預處理器進行預解釋，並且文檔字符串由標准 sphinx 解釋器解釋。我的圖像被正確可視化，但參數和返回值沒有被正確解釋，它們看起來像純文本。當我刪除 ...

Python 代碼中注釋和文檔字符串的基本語法

[英]Basic Syntax of comments and docstrings in Python code

我正在學習如何使用Sphinx為我的代碼創建文檔。在我看到一些這樣的例子之后：def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real pa ...

我應該記錄類似 function 簽名的參數嗎？

[英]Should I document parameters for similar function signatures?

我有一些輔助函數，除了第一個參數外，它們采用與核心 function 相同的 arguments。這些參數在核心 function 中有詳細記錄。我也應該將此文檔復制粘貼到幫助程序 function 中，還是直接指向核心文檔？重要的是，我主要打算將我的 API 參考讀取為由 Sphinx 生 ...

如何從 sphinx napoleon 和 numpy 風格的文檔中獲得與默認的 rst 方式相同的輸出？

[英]How to get the same output from sphinx napoleon and numpy style docs as with the default rst way?

如果我采用非常簡單的python文件： def magic_function(parameter1): """ Do magic with parameter1. :param parameter1: The first of all paramters :type ...

強制 Sphinx 在 Python 文檔字符串而不是 reStructuredText 中解釋 Markdown

[英]Force Sphinx to interpret Markdown in Python docstrings instead of reStructuredText

我正在使用 Sphinx 來記錄一個 python 項目。我想在我的文檔字符串中使用 Markdown 來格式化它們。即使我使用recommonmark擴展名，它也只涵蓋手動編寫的.md文件，而不是文檔字符串。我在我的擴展中使用autodoc 、 napoleon和recommonmark ...

我可以使用 Sphinx automodule 但在簽名中刪除模塊名稱嗎？

[英]Can I use Sphinx automodule but drop the module name in the signature?

我有一個帶有一些子模塊submod的模塊mod ，並使用.. automodule:: mod.submod為其生成文檔。模塊中元素（函數、類等）的簽名現在顯示限定名稱，如mod.submod.my_function(*args, **kwargs) 。相反，我希望 Sphinx 只顯示函數的 ...

獅身人面像中參數部分外的文本

[英]Text outside parameters section in sphinx

我正在使用拿破侖語法為我的函數編寫文檔。我想在文檔中的參數列表之后有一個段落。文檔目前看起來像這樣：文檔當前呈現（使用 RTD 主題）為 x ( a ) 一個示例函數。之前的示例簡介。參數* a ( str ) - 輸入參數 * ( A )之后的段落- 我想看到的 ...

如何在 Python 的函數文檔字符串中指定多個返回類型？

[英]How to specify multiple return types in a function docstring in Python?

我知道用於為 Google 樣式構建文檔字符串的語法，例如：但是，如果我有一個函數可以根據執行的代碼分支返回多種類型怎么辦？記錄這一點的正確方法是什么？下面是一個例子。 Returns部分應該放什么？有一個示例顯示了兩種不同的可能返回類型：但是，我想知道提供這兩種類型和描述 ...