Questions tagged «python-sphinx»

Sphinx是一种工具,可轻松创建智能且美观的文档。Sphinx特别适用于Python文档,但它是一种通用工具,可用于记录所有内容。


6
Sphinx autodoc不够自动化
我正在尝试使用Sphinx在Python中记录5,000多个项目。它有大约7个基本模块。据我所知,为了使用自动文档,我需要为项目中的每个文件编写如下代码: .. automodule:: mods.set.tests :members: :show-inheritance: 这太繁琐了,因为我有很多文件。如果我只想指定要记录的“ mods”包,那会容易得多。然后,Sphinx可以递归地浏览包并为每个子模块创建一个页面。 有这样的功能吗?如果没有,我可以编写一个脚本来制作所有.rst文件,但这将花费很多时间。


5
如何使用Sphinx的自动文档来记录类的__init __(self)方法?
Sphinx默认情况下不会为__init __(self)生成文档。我尝试了以下方法: .. automodule:: mymodule :members: 和 ..autoclass:: MyClass :members: 在conf.py中,设置以下内容只会将__init __(self)文档字符串附加到类文档字符串(Sphinx autodoc文档似乎同意这是预期的行为,但未提及我要解决的问题): autoclass_content = 'both'

7
sphinx-build失败-autodoc无法导入/查找模块
我正在尝试开始使用Sphinx,似乎遇到了很多问题。 命令: docs/sphinx-quickstart 我回答所有问题,一切正常。 命令: docs/ls 一切看起来都很正常。结果:build Makefile source 命令: sphinx-build -d build/doctrees source build/html 似乎有效。我能够打开index.html文件,并看到我想要的“外壳”。 当我尝试将实际的源代码作为source文件夹时,我遇到了问题。 命令: sphinx-build -d build/doctrees ../ys_utils build/html 结果: Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html loading intersphinx inventory from http://docs.python.org/objects.inv... building [html]: targets …


5
如何使用Doxygen记录Python代码
已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗?更新问题,使其仅通过编辑此帖子来关注一个问题。 2年前关闭。 改善这个问题 我喜欢Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目,我想我还记得Python没有/* .. */评论,也有自己的自我文档编制功能,这似乎是Python的记录方式。 既然我熟悉Doxygen,如何使用它来生成我的Python文档?有什么特别需要我注意的吗?

2
如何在reStructuredText中创建嵌套列表?
我正在尝试使用以下代码(在Sphinx和docutils文档之后)创建正确嵌套的列表: 1. X a. U b. V c. W 2. Y 3. Z 我希望这将导致两个OLs,但是我得到以下输出: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol class="loweralpha simple"> <li>U</li> <li>V</li> <li>W</li> </ol> </div> </blockquote> <ol class="arabic simple" start="2"> <li>Y</li> <li>Z</li> </ol> 我究竟做错了什么?无法获得以下结果? <ol class="arabic simple"> <li>X <ol class="loweralpha simple"> <li>U</li> <li>V</li> <li>W</li> </ol> </li> …

6
sphinx可以链接到不在根文档下的目录中的文档吗?
我正在使用Sphinx记录非Python项目。我想./doc在每个子模块中分发文件夹,其中包含submodule_name.rst用于记录该模块文件的文件。然后,我想将这些文件吸收到主层次结构中,以创建整个设计的规范。 即: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src 我试图project_spec.rst像这样在主文档toctree中包含文件: .. toctree:: :numbered: :maxdepth: 2 Module 1 <../../modules/module1/docs/module1> 但是,此错误消息导致: 警告:toctree包含对不存在的文档u'modules / module1 / docs / module1'的引用 是否无法以../某种方式在文档路径中使用? 更新:添加了conf.py位置 更新:除了下面的包含技巧之外,仍然不可能(2019)。有一个开放的问题一直在推进:https : //github.com/sphinx-doc/sphinx/issues/701

3
链接到python docstring中的类方法
我想从同一个类的另一个方法的文档字符串中添加指向我的类中的方法的链接。我希望链接在sphinx中工作,最好在Spyder和其他Python IDE中工作。 我尝试了几种选择,但发现只有一种可行,但这很麻烦。 假设以下结构 mymodule.py def class MyClass(): def foo(self): print 'foo' def bar(self): """This method does the same as <link to foo>""" print 'foo' 我尝试了以下选项<link to foo>: :func:`foo` :func:`self.foo` :func:`MyClass.foo` :func:`mymodule.MyClass.foo` 唯一有效产生链接的链接是:func:`mymodule.MyClass.foo`,但是该链接显示为mymodule.MyClass.foo(),我想要一个显示为foo()或的链接foo。 上面的选项均未在Spyder中生成链接。 谢谢你的帮助。

4
在reStructuredText中的链接中设置文本格式
如何格式化reStructuredText中指定链接内的文本? 具体来说,我希望从我的第一个脚本中生成以下HTML: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 结果应如下所示: optparse.OptionParser 文件资料 其中“ optparse.OptionParser”部分为固定宽度的字体。 我试过了 ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ 但是,这给了 <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ 看起来像这样 ``optparse.OptionParser documentation <http://docs.python.org/library/optparse.html>\_

1
Sphinx错误:未知的指令类型“ automodule”或“ autoclass”
我需要使用Sphinx记录我的Python项目。但是我不能用autodoc。 当我配置我的项目时,我选择选项“ extension autodoc”,但是现在如果我使用 .. autoclass:: Class 我收到一个错误: ERROR: Unknown directive type "autoclass" 我配置了PYTHONPATH,现在很好。但是我已经有这个问题了。 我的索引文件是: .. ATOM documentation master file, created by sphinx-quickstart on Thu Nov 22 15:24:42 2012. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to …

4
指定指向numpy,scipy和matplotlib的Intersphinx链接的目标
在用于在软件包之间设置Sphinx文档链接的文档之后,我添加了 intersphinx_mapping = {'python': ('http://docs.python.org/2', None), 'numpy': ('http://docs.scipy.org/doc/numpy/', None), 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} 对我来说conf.py,但似乎无法获得除Python本身以外的任何项目的链接。例如 :term:`svg graphics <matplotlib:svg>` 只是将我带到索引页面,而没有添加预期的#term-svg锚点,而且我什至无法找到术语表,也无法确定scipy如何确定软件包支持哪些:ref:s或:term:s。 我在哪里可以找到如何指定目标指令:ref:S和:term:S IN numpy,scipy和matplotlib? 为此,我如何链接到Sphinx本身?新增中 intersphinx_mapping['sphinx'] = ('http://sphinx-doc.org/', None) 和 :ref:`Intersphinx <intersphinx>` 不起作用。

1
文档读取失败,并显示“无法从'pip._internal.index'导入名称'PackageFinder'”
Sphinx文档在read-the-docs上的构建失败,并显示以下错误(以下完整日志): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) 我做错什么了吗?或者这是阅读文档中的错误? Sphinx文档的本地版本运行良好。 阅读文档时完整的错误日志: Read the Docs build information Build id: 10299638 Project: cascade-python Version: latest Commit: a7d50bf781bd8076b10dd7024db4ccb628016c27 Date: 2020-01-21T17:03:12.876711Z State: finished Success: False [rtd-command-info] start-time: 2020-01-21T17:03:13.203354Z, end-time: 2020-01-21T17:03:13.215400Z, duration: 0, exit-code: 0 git remote set-url origin https://github.com/brunorijsman/cascade-python.git [rtd-command-info] start-time: 2020-01-21T17:03:13.276220Z, end-time: …

2
为什么从包含问号的第一个文件转换而来的html文件在单击目录时无法显示在浏览器上?
请下载文件simple.7z并安装在您的sphinx中以重现我在这里描述的问题,为了重现它,您可以运行: make clean make html 下载并安装在您的狮身人面像以重现问题 中有两篇文章sample/source,内容相同,只是标题不同。 cd sample ls source |grep "for-loop" What does "_" in Python mean in a for-loop.rst What does "_" in Python mean in a for-loop?.rst 一个包含?在其中,另一个不包含?。跑步后发生了奇怪的事情make html。 make html ls build/html|grep "for-loop" What does "_" in Python mean in a for-loop.html What does "_" …
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.