我想为我的包生成文档。项目中的每个文件都包含大量文档。有没有办法快速将我的整个项目添加到文档索引中？我想用尽可能少的工作为整个项目自动生成一些文档。我首先将以下内容添加到index.rst:..automodule::mymodulename:members:似乎所做的只是__init__.py文件中的文档元素(只是一个文档字符串)——有什么方法可以让它记录其他所有内容吗？我希望添加包中定义的所有内容，并将包中的每个类、常量、函数(等)添加到适当的索引中。这可以做到吗？ 最佳答案 您可以使用sphinx-apidoc。来自offic

我有一个类似下面的Python类，其中的文档字符串旨在通过Sphinx转换为文档。:classDirection(object):"""Adirectioninwhichmovementcanbemade."""def__init__(self):self._name=None@propertydefname(self):"""Theuniquenameofthedirection.:return:Thedirectionname:rtype:string"""returnself._name@name.setterdefname(self,value):"""Setsthedirec

我刚开始使用Sphinx工具为我的代码生成文档。但我有点困惑，因为它并不像我预期的那么容易。我使用以下方法创建Sphinx文档:sphinx-quickstart然后我将我的*.rst文件创建到“源”文件夹中。似乎我需要为每个要为其创建文档的模块创建一个*.rst文件。对于test.py，我创建了test.rst。在test.rst中，我有:..automodule::test:members::show-inheritance:然后在test.py中，我有:"""..module::test:platform:Unix,Windows:synopsis:Ausefulmodulein

(使用Python-Sphinx文档工具)我有一个.txt日志文件，我想将其构建到_build/html未更改中。我需要在conf.py、index.rst等中更改什么这是布局:src/index.rstsome_doc.rstsomefile.txt如何将somefile.txt放入html构建中？我尝试添加这样一行到index.rst:Contents:..toctree:::maxdepth:2some_doc"somefile.txt"希望它能靠魔法起作用，但这里没有魔法!假设这是可能的，我会在some_doc.rst中放入什么来引用/链接到那个文件？注意是的，我知道我可以把它

问题背景:我想在我的django项目中使用sphinx编写文档，并使用我的django代码注释自动创建文档。现在我有一个django(1.9)项目，文件结构如下:myproject/myproject/__init__.pysettings.pyurls.pywsgi.pymyapp/migrations/__init__.pyadmin.pymodels.pytests.pyviews.pydocs/_build/_static/_templates/conf.pyindex.rstMakefile然后，如您所见，我放置了一个docs文件夹，其中包含一个Sphinx文档项目。现在我可

这个问题在这里已经有了答案:Sphinx--combiningautomoduleandautoclass(2个答案)关闭2年前。我尝试使用sphinx及其autodoc插件为包含数千个类的项目创建html文档。sphinx-apidoc创建精彩的初始文件，但缺少自动创建autoclasses和automethods。sphinx中是否有一种方法/命令/实用程序可以在文档中自动包含所有变量、函数、类和装饰器？第一个文件的一些示例代码:taggerPackage=================:mod:`tagger`Package------------------------..a

我正在使用Sphinxautodoc扩展来记录模块，我想在文档输出中获取模块成员的平面列表。我尝试使用以下方法:..automodule::modname:members:但是，这有两个问题:它包括模块的文档字符串，我不在这里想要它。每个条目的名称都以“modname.”为前缀，这是完全多余的(因为此页面专门用于记录此模块)但是，我找不到任何配置选项可以让我有选择地禁用这两个方面，同时仍然获得所有模块成员的自动列表。我目前的计划是只使用自动函数(等)并显式枚举要记录的成员，但我仍然想知道我是否错过了实现我最初想要的东西的简单方法。更新:我至少找到了第二部分的解决方法:在conf.py中

我有以下包结构作为最小示例(为方便起见，全部上传here):.├──sphinx│  ├──build│  ├──Makefile│  └──source│  ├──conf.py│  ├──index.rst│  └──train.rst└──train├──__init__.py└──train.py编写Python包时，必须在任何包的__init__.py中指定__all__常量，以便Sphinx能够映射引用，例如train.DatasetMeta到train.train.DatasetMeta或类似的。但是，sphinx-apidoc为这些包生成以下部分:trainpackag

我想将我项目的README.md包含到我的Sphinx文档中，如Cansphinxlinktodocumentsthatarenotlocatedindirectoriesbelowtherootdocument?-在生成的Sphinxhtml文档中，我单击欢迎页面目录中的链接并转到README.md。为此，创建了一个文档readme_link.rst，其中包含以下行ReadmeFile-----------..include::../../README.md然后我添加行README进入index.rst目录树。随之而来的是，我的README.md没有被解析为Markdown，而是按原

我正在使用Sphinx记录我的一个项目，我喜欢在浏览器中预览我的更改。我希望能够将一些更改保存到.rst文件，并能够立即刷新我的浏览器并查看更改。本质上，只要其中一个.rst文件发生更改，我就想自动执行makehtml。 最佳答案 您可以使用sphinx-autobuild.使用方便，例如:sphinx-autobuilddocsdocs/_build/html或者，如果您有单独的构建目录，sphinx-autobuildsourcebuild/html它还会在浏览器中自动启动页面刷新。