python-sphinx 相关问题

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

在Windows上安装python / sphinx环境?

我们在Linux / OSX python环境中使用Sphinx作为文档,但我们在Windows上有人希望能够获得一个可以编辑和构建Sphinx的环境......

回答 3 投票 9

在sphinx中更新docstring

我正在努力为dask项目的文档做出贡献。我想按照本期的建议添加pandas参考。我能够在我的开发者机器上重建文档 - 但我......

回答 1 投票 1

如何为namedtuple(使用autodoc)提供Sphinx文档?

我正在尝试使用Sphinx记录Python项目,但是我在将autodoc扩展与namedtuple生成的类组合时遇到了麻烦。在一个文件gammatone.rst中,我有:: mod:`...

回答 3 投票 12

在gh-pages上托管的sphinx html中的散景图JS路径

我试图在RST文件中使用散景图扩展使用散景图扩展来在gh-pages上托管一些基于sphinx的文档。我能够提供生成的HTML和...

回答 1 投票 0

autodoc:基类以全名显示,而不是尊重导入

我希望我能找到解决这个非常复杂问题的解决方案。我使用sphinx和intersphinx来记录我的项目。我有一个继承自mongoengine.Document的类。当我构建sphinx文档时......

回答 1 投票 0

如何使用sphinx生成sitemap.xml文件?

这里它说:“特殊条目名称self代表包含toctree指令的文档。如果你想从toctree生成一个”站点地图“,这很有用。”我一直在看......

回答 1 投票 4

是否可以将sphinx预生成的html文档上传到ReadTheDocs网站?

我有一个使用plot-directive的python-3项目,但ReadTheDocs目前不支持这个项目。因此,我想生成并上传文件,就像我通常使用PyPi一样...

回答 1 投票 18

Sphinx matlab文档错误:缺少模块'std'

我正在尝试使用sphinx记录我的MATLAB类。但每当我想运行make html时,我都会收到以下错误:%make html sphinx-build -b html -d _build / doctrees。 _build / html正在运行...

回答 2 投票 3

我如何在Sphinx中模拟wxPython?

我使用wx-python v4.0.0b2(Phoenix)创建了一个项目,我正在尝试使用Sphinx来记录它。我有一个目录结构如下:app / | ---- models / | | ----__ init__.py | ...

回答 1 投票 1

在使用Sphinx文档时,我应该告诉VCS忽略哪些文件? [关闭]

我想开始使用Sphinx记录我的项目。我告诉Sphinx在sphinx-quickstart期间使用单独的源代码和构建目录。现在我的目录布局如下:MyProject / ...

回答 2 投票 18

如何在reStructuredText中创建嵌套列表?

我正在尝试使用以下代码创建一个正确的嵌套列表(遵循Sphinx和docutils文档):1。X a。你b。 V c。 W 2. Y 3. Z我希望这会产生两个OL,但我得到......

回答 2 投票 71

Sphinx将0添加到我的引用ID

我有一个包含以下几行的第一个文件......这个例子经过分析后找到了作者的论文[Hughes2017] _。 .. [Hughes2017] Hughes,M.,Olsen,J.,*关于......的潜力

回答 1 投票 1

PyPi:如何上传文档以及如何更改包描述?

1.文档如何将压缩的sphinx文档添加到PyPi上的包中?曾经有一个上传文档按钮,但这被一个销毁文档替换。这个按钮......

回答 1 投票 0

如何使用intersphinx正确链接到PyQt5文档?

我试图使用intersphinx链接到PyQt5文档时遇到了一些麻烦。试图交叉引用任何QtCore类(例如QThread)并不像我期望的那样工作。我已经解析了......

回答 1 投票 3

sphinx备份一个目录

我按照本指南设置了Sphinx。我的目录如下:/ cms-service / documentation / modules models.rst指南告诉你把python文件的路径放在...

回答 1 投票 1

是否可以重新使用restructuredtext(或sphinx)中另一个文件中定义的超链接

假设我在同一个文件夹中有两个文件a.rst和b.rst,而a.rst看起来像这样.. _foo:http://stackoverflow.com`foo`_是一个网站似乎在b.rst中使用foo不被允许。有没有 ...

回答 2 投票 1

Sphinx和blockdiag:非英文字符给出UnicodeEncodeError

我有一个RST文件用Sphinx编译。我有一个方框图。我想给它的一些节点提供非英文名称。 .. blockdiag :: diagram {“UberMega” - >“HellSotona” - > ...

回答 2 投票 1

我怎样才能让sphinx使用Python 3作为解释器?

我正在用sphinx构建文档。我使用conda设置并使用我在其间切换的py27和py36版本的python。在运行sphinx-build ./source ./build时出现以下错误:警告:...

回答 1 投票 0

如何覆盖readthedocs上的模板?

我最近为readdhedocs添加了针对blowdrycss的sphinx文档。我想覆盖readthedocs上的layout.html模板。我当前的模板覆盖在localhost上工作正常,但不在...

回答 2 投票 3

隐藏主TOCTree中的Sphinx子部分

是否可以隐藏主TOCTree中RST文件中存在的一个(或所有)子部分?让我再描述一下:index.rst:doc:`Label `^^^^^^^^^^^^^^^^^^^^^^^^^^ ...

回答 4 投票 10

© www.soinside.com 2019 - 2024. All rights reserved.