python-sphinx 相关问题

Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。

如何使用sphinx标记引用已记录的Python函数参数？我想在python docstring中的其他地方引用以前文献的函数参数。考虑以下（公认是完全人为的）示例： def foo（bar）： “”“执行foo

def foo(bar): """Perform foo action :param bar: The bar parameter """ def nested(): """Some nested function that depends on enclosing scope's bar parameter. I'd like to reference function foo's bar parameter here with a link, is that possible?""" return bar * bar # ... return nested()

python python-sphinx docstring

回答 4 投票 0

当使用狮身人面像和狮身人面像重定向时，我如何维护URL片段？

javascript http-redirect documentation python-sphinx url-fragment

回答 1 投票 0

如何在使用sphinx-doc中使用Autoclass的方法之前订购类属性？

documentation python-sphinx autodoc autoclass

回答 1 投票 0

然后将其翻译成等效的

python-sphinx

回答 1 投票 0

可以自动将巨大模块拆分为几页？

恢复HTML很痛苦，并且定期崩溃浏览器页面很痛苦。

python-sphinx sphinx autodoc

回答 1 投票 0

Sphinx命令行实用程序

python-sphinx

回答 1 投票 0

我如何使用狮身人面像的标签和引用是唯一的？我正在使用狮身人面像生成文档。我几乎没有（

50）生成的第一个文件包含描述，但是在文件夹之间标签和引用并不唯一。 <10) folders with a lot of (>folder_1 file_a label a_text1 label a_text2 file_b label b_text1 label b_text2 folder_2 file_a label a_text1 label a_text2 file_b label b_text1 label b_text2

python python-sphinx restructuredtext

回答 0 投票 0

Sphinx在github动作上失败：ghostscript

ubuntu-22.04

github-actions python-sphinx ghostscript

回答 1 投票 0

阅读文档主题 - 使用sphinx

阅读文档主题来使用sphinx创建HTML内容。在主题中，我想编辑“在GitHub上编辑”部分的超链接。我能够使用以下变量在

html python-sphinx read-the-docs

回答 3 投票 0

<code>aiohttp</code>

python-sphinx aiohttp read-the-docs

回答 0 投票 0

用狮身人面像/重组的文本缩放图像上的图像纵横比我有一些用狮身人面像构建的文档，我希望我的缩放图像（图）的行为与未量化的数字相同。例如，一个数字称为 ..图:: Images/Manual_exposure1.png ...

.. figure:: images/manual_exposure1.png

css python-sphinx restructuredtext

回答 1 投票 0

Sphinx-needs会生成不可行的：链接：使用AutoSummary

标签，因此只有纯文本。

hyperlink python-sphinx docstring autosummary

回答 0 投票 0

SPHINX“唯一”指令列表？

当使用Sphinx中使用重组文本时，如何使用唯一的指令获得可选的列表项目？例如： foo bar： - a - b ..只有::内部 -c - d 以上问题是它

documentation python-sphinx restructuredtext

回答 1 投票 0

我正在努力地建立我的文档基于readthedocs。在本地，一切都很好，但是我的

version: 2 build: os: ubuntu-22.04 tools: python: "3.10" sphinx: configuration: conf.py output_dir: $READTHEDOCS_OUTPUT/html formats: - pdf - epub - htmlzip python: install: - requirements: requirements.txt

python-sphinx read-the-docs

回答 1 投票 0

这是我的索引。 ..包括:: ../ readme.md ：parser：myst_parser.sphinx_ .. Toctree :: ：maxdepth：1 readme.rst .. Toctree :: ：maxdepth：1 ：字幕：教程：：glob： Notebo ...

markdown python-sphinx read-the-docs

回答 1 投票 0

我如何修复仅在readthedocs上发生的autoapi.not_radable错误？当我尝试在readThedocs上构建文档时，我在每个软件包文件中都会遇到错误。错误是[autoapi.not_radable]。其中最奇怪的部分是我的Documentati ...

。

python-sphinx read-the-docs sphinx-napoleon

回答 0 投票 0

Python-sphinx：“继承”方法文档来自SuperClass

Edit：截至目前（Sphinx 1.4.9），似乎没有办法告诉狮身人面像做我想做的事（请参阅Github上的问题）。 Brecht Machiels接受的答案以另一种方式解决了该问题，直到SP ...

python inheritance python-sphinx docstring