构建模块目录的正确方法是什么，以便Sphinx扩展autodoc可以访问使用sphinx-apidoc找到的所有文件？

文章/答案/技术大牛

发布

1回答

python、python-sphinx、autodoc

我正在尝试使用Sphinx为我最近开始创建的一个模块制作文档。我如何组织我的代码，以便autodoc和python都可以正确地读取它？我有以下文件结构，inference.py在其中从create_data.py导入Class [meg_analysis] |-[docs] | |-{filescreated by apidoc} |-create_data.py

浏览 19提问于2019-08-28得票数 0

回答已采纳

2回答

是否从sphinx autodoc中发出reStructuredText？

python、python-sphinx、autodoc

CPython的文档没有使用autodoc --我们使用的是手写的文章。使用sphinx-apidoc为依赖于autodoc的模块发出Sphinx项目运行创建新reStructuredText源

浏览 60提问于2012-04-30得票数 22

回答已采纳

1回答

在Python项目文档中使用Sphinx的正确工作流是什么？

python、python-sphinx、sphinx-apidoc

我想使用狮身人面像记录一个大型项目，目前还没有很好的文档。特别是，我希望在编写文档时使用sphinx-apidoc从代码中生成文档。不过，我也想要一些关于如何使用项目等的教程，但似乎当我调用sphinx-apidoc时，它会立即生成整个文档。因此，我的问题是:这里的正确工作流是什么，这样我就可以编写要手动编写的教程页面，同时更新代码中的文档？注意

浏览 5提问于2014-02-28得票数 6

回答已采纳

1回答

在Sphinx文档生成器中，我可以将整个包(递归地)添加到索引中吗？

python、python-sphinx

我想为我的包生成文档。项目中的每个文件都包含大量文档。有没有办法快速地将我的整个项目添加到文档索引中？.. automodule:: mymodulename所做的一切似乎都是在__init__.py文件中记录元素(只是一个文档字符串)--有没有什么方法可以让它记录其他所有内容？我希望添加我<

浏览 2提问于2012-01-10得票数 13

回答已采纳

1回答

在python配置中“autodoc_default_flags”是如何工作的？

python、python-sphinx、autodoc、numpydoc、sphinx-napoleon

我试图使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。我有很多模块，我希望每个模块只显示类名，而不是类中的完整方法列表(所有这些方法都在我的代码中有文档字符串)。而且html页面将方法和它们的docstring完全放在一起。 FWIW，

浏览 7提问于2016-04-02得票数 8

回答已采纳

1回答

在sphinx-apidoc生成的文件中包括main.py。

python、python-sphinx、autodoc、sphinx-apidoc

在用sphinx-apidoc.生成RST文件时，无法正确添加__main__.py文件及其函数其他文件和类是正确生成的。d

浏览 0提问于2019-01-11得票数 1

回答已采纳

1回答

有没有办法在Sphinx中预编译由autodoc生成的.rst文件

python、python-sphinx、autodoc、read-the-docs

我有一个项目，我使用sphinx.ext.apidoc为该项目构建了一组.rst文件，可以从项目的文档字符串中提取文档。，但是要求我编辑conf.py文件以将我的项目添加到python系统路径中，以便当autodoc尝试导入.rst文件时，它能够正确地找到这些模块。但是，当我尝试在readthedocs上构建文档时，autodoc</em

浏览 0提问于2015-03-11得票数 1

2回答

在制作sphinx* autodoc时如何忽略python项目中的src目录*

python、python-sphinx、setup.py、autodoc

(另一种描述可以是“如何重命名斯芬克斯-autodoc包名？”) 我希望使用docstring和sphinx-apidoc自动创建文档。在使用相当标准的选项(扩展、autodoc和intersphinx )执行sphinx-quickstart之后。没有分离的源目录和生成目录。)添加make.bat和Makef

浏览 0提问于2018-03-21得票数 3

回答已采纳

1回答

从不工作的docstring生成sphinx* docu*

python、python-sphinx

# testing util stuff我想从文档字符串构建文档。我使用sphinx的快速启动来生成必要的配置，但是当我调用make hmtl时，生成的docu不包含来自我的源代码的任何docstring，即my_project/src/my_project中的所有内容配置文件中

浏览 2提问于2018-04-17得票数 4

回答已采纳

1回答

如何使Sphinx自动文档在源目录之外生成？

python、documentation、python-sphinx

，但我们只需移动文件： build conf.py Makefile我将autodoc添加到autodoc：这就产生了： build [RST，my_source_dir中的文件就没有被检测到。我的医生

浏览 6提问于2022-08-18得票数 -1

1回答

如何使用Sphinx记录Python包

python、package、python-sphinx、sphinx-apidoc

目前，我有以下目录结构：└── project │ ├── doctrees │ ├── _sources的结果。，我有extensions = ['sphinx.ext.autodoc']。..maxdepth: 2 ================== * :ref:`mod

浏览 3提问于2014-08-28得票数 12

回答已采纳

3回答

使用Sphinx时不生成模块索引"modindex“

python-sphinx

我在使用sphinx-build创建文档目录(html)时遇到麻烦。我试过了以及但在这两种情况下，只生成html文件search.html、index.html和genindex.html文件modindex.html丢失。html_domain_indices = True 所以我应该有一个modindex.html文

浏览 8提问于2012-12-12得票数 45

1回答

狮身人面像(氏)自动调节器，显然没有作用

python、python-sphinx、autodoc、sphinx-apidoc

我还有一个子目录apidoc，其中包含一个文件agent.rst (由sphinx-apidoc生成)：============ .. automodule:: agent，项目的目录是当前的工作目录。它运行时没有错误，但当我打开生成的HTML文件时，它只显示“代理模块”，所有内容都是空的。为什么它不显示类Agent及其成员呢？Update：最初的问题

浏览 4提问于2020-01-24得票数 6

回答已采纳

1回答

Sphinx autodoc/拿破仑不生成文档字符串

python、python-sphinx、autodoc、sphinx-napoleon

和'sphinx.ext.autodoc',]它在每个文件中创建一个标题和一个树。没有

浏览 4提问于2022-01-31得票数 0

回答已采纳

2回答

genindex和modindex页脚链接在readthedocs.io中不起作用

python-sphinx、restructuredtext、read-the-docs、autodoc

我有一个Python项目，使用Sphinx作为文档。我正在readthedocs.io服务上远程构建文档。我使用了sphinx-quickstart，它生成了一个具有以下链接的index.rst文件：~~~~~~~~~~~~~~~~~~ * :ref:`genindex遵循本指南：，我运行了sphinx-apidoc -o api-docs/ ../myproject来生成自动文档.rst<

浏览 2提问于2020-11-05得票数 0

回答已采纳

2回答

使用NumPyDoc样式的带有Napoleon Sphinx扩展的类方法列表

python、documentation、numpydoc、sphinx-napoleon

我正在使用NumPyDoc样式的文档字符串来记录一个Python包。我想从 Sphinx扩展切换到，因为我发现它以更紧凑和可读性更强的方式格式化了文档字符串。但是，它没有在文档的顶部列出类的方法，这是numpydoc的一个非常有价值的特性。有人知道如何在拿破仑中手动打开它吗？

浏览 18提问于2017-01-20得票数 10

2回答

在一个python文件上运行Sphinx的最简单方法

python、python-sphinx

我们有一个Sphinx配置，它将为我们的整个代码库生成大量HTML文档。有时，我正在处理一个文件，我只想查看该文件的HTML输出，以确保在不运行整个套件的情况下语法正确。我寻找了一个在终端上运行的最简单的命令来对这个文件运行sphinx，我确信信息就在那里，但我没有看到它。

浏览 2提问于2012-05-22得票数 16

5回答

狮身人面像找不到我的python文件。上面写着“没有模块名.”

python、python-3.x、python-sphinx、autodoc

这个目录位于C:\Users\Sam\Desktop\picnic-data-shared-tools\standalone\slotting_tool当试图使用sphinx-build -b html source .在生成中没有引用run_me.py的HTML页面。我尝试将我<

浏览 3提问于2018-12-07得票数 6

4回答

自动生成所有Python包内容的文档

python、python-sphinx、documentation-generation、sphinx-apidoc

我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我在指示Sphinx递归扫描我的文件时遇到了困难。，Sphinx假定我将为代码库中的每个模块/类/函数手动创建文档文件。但是，我确实注意到了"automodule“语句，并且我在快速入门期间启用了autodoc，所以我希望大多数文档都能自动生成。我修改了我的conf.py以将我的</

浏览 5提问于2011-01-06得票数 54

回答已采纳

2回答

阅读不使用自动模式的文档

python、python-sphinx、docstring、read-the-docs

我为我的项目编写了一些文档(在Python中)，并在本地计算机上用Sphinx测试了所有东西--一切正常工作，所有导入工作都正确，等等。因此，我在Read (Python 3、numpydoc和我的库)上设置了一个自定义环境，将docs目录(和docs/source子目录)添加到我的Github中，然后读取文档的构建就通过了，但是没有创建任何东西日志如下：

浏览 2提问于2014-07-29得票数 11

点击加载更多