Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
我想使用Sphinx的autosummary扩展和模板从docstrings递归生成API文档。我想为每个模块，类，方法，属性和功能分别设置页面。但它不......
升级到1.5.1版后，我的Sphinx文档中的搜索功能已停止工作。我正在使用sphinx_rtd_theme。如何将Sphinx降级到1.4.9？
我有一个名为version.h的文件，其中包含以下行：#define VERSION 0.4.2-b现在，在这个软件的Sphinx文档中，我想显示这个......
如何在Sphinx处理的文档字符串中为单个参数或返回值表示多个类型？
有时Python中的函数可能接受灵活类型的参数。或者它可以返回灵活类型的值。现在我不记得现在这样一个功能的好例子，因此我...
sphinx严重：意外的部分标题 - 函数docstring中的任意标题
使用autodoc和类似工具可以从源文档字符串编译文档。但是，它似乎不允许函数或类docstrings中的任意ReST部分标题，并且......
我们在Linux / OSX python环境中使用Sphinx作为文档，但我们在Windows上有人希望能够获得一个可以编辑和构建Sphinx的环境......
我正在努力为dask项目的文档做出贡献。我想按照本期的建议添加pandas参考。我能够在我的开发者机器上重建文档 - 但我......
如何为namedtuple（使用autodoc）提供Sphinx文档？
我正在尝试使用Sphinx记录Python项目，但是我在将autodoc扩展与namedtuple生成的类组合时遇到了麻烦。在一个文件gammatone.rst中，我有:: mod：`...
在gh-pages上托管的sphinx html中的散景图JS路径
我试图在RST文件中使用散景图扩展使用散景图扩展来在gh-pages上托管一些基于sphinx的文档。我能够提供生成的HTML和...
我希望我能找到解决这个非常复杂问题的解决方案。我使用sphinx和intersphinx来记录我的项目。我有一个继承自mongoengine.Document的类。当我构建sphinx文档时......
这里它说：“特殊条目名称self代表包含toctree指令的文档。如果你想从toctree生成一个”站点地图“，这很有用。”我一直在看......
是否可以将sphinx预生成的html文档上传到ReadTheDocs网站？
我有一个使用plot-directive的python-3项目，但ReadTheDocs目前不支持这个项目。因此，我想生成并上传文件，就像我通常使用PyPi一样...
我正在尝试使用sphinx记录我的MATLAB类。但每当我想运行make html时，我都会收到以下错误：％make html sphinx-build -b html -d _build / doctrees。 _build / html正在运行...
我使用wx-python v4.0.0b2（Phoenix）创建了一个项目，我正在尝试使用Sphinx来记录它。我有一个目录结构如下：app / | ---- models / | | ----__ init__.py | ...
在使用Sphinx文档时，我应该告诉VCS忽略哪些文件？ [关闭]
我想开始使用Sphinx记录我的项目。我告诉Sphinx在sphinx-quickstart期间使用单独的源代码和构建目录。现在我的目录布局如下：MyProject / ...
我正在尝试使用以下代码创建一个正确的嵌套列表（遵循Sphinx和docutils文档）：1。X a。你b。 V c。 W 2. Y 3. Z我希望这会产生两个OL，但我得到......
我有一个包含以下几行的第一个文件......这个例子经过分析后找到了作者的论文[Hughes2017] _。 .. [Hughes2017] Hughes，M.，Olsen，J.，*关于......的潜力
1.文档如何将压缩的sphinx文档添加到PyPi上的包中？曾经有一个上传文档按钮，但这被一个销毁文档替换。这个按钮......
我试图使用intersphinx链接到PyQt5文档时遇到了一些麻烦。试图交叉引用任何QtCore类（例如QThread）并不像我期望的那样工作。我已经解析了......
我按照本指南设置了Sphinx。我的目录如下：/ cms-service / documentation / modules models.rst指南告诉你把python文件的路径放在...