默认情况下,Sphinx不会为__init __(self)生成文档.我尝试过以下方法:
.. automodule:: mymodule
:members:
和
..autoclass:: MyClass
:members:
在conf.py中,设置以下内容只会将__init __(self)docstring附加到类docstring(Sphinx autodoc文档似乎同意这是预期的行为,但没有提到我正在尝试解决的问题):
autoclass_content = 'both'
如何在reStructuredText中的表示链接中格式化文本？
具体来说,我希望从我的第一个生成以下HTML:
<a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a>
结果应如下所示:
其中"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>\_
第一次尝试使用Sphinx,使用干净的Sphinx 1.1.3安装,shinx-quickstart失败.是否应该安装任何依赖项？我试过,pip --force-reinstall sphinx但结果是一样的.
myhost:doc anton$ sphinx-quickstart
Traceback (most recent call last):
File "/usr/local/bin/sphinx-quickstart", line 8, in <module>
load_entry_point('Sphinx==1.1.3', 'console_scripts', 'sphinx-quickstart')()
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 318, in load_entry_point
return get_distribution(dist).load_entry_point(group, name)
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 2221, in load_entry_point
return ep.load()
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 1954, in load
entry = __import__(self.module_name, globals(),globals(), ['__name__'])
File "/Library/Python/2.7/site-packages/Sphinx-1.1.3-py2.7.egg/sphinx/quickstart.py", line 19, in <module>
from sphinx.util.osutil import make_filename
File "/Library/Python/2.7/site-packages/Sphinx-1.1.3-py2.7.egg/sphinx/util/__init__.py", line 25, in <module>
from docutils.utils import relative_path
File "/Library/Python/2.7/site-packages/docutils-0.9-py2.7.egg/docutils/utils/__init__.py", line 19, in <module>
from docutils.io import …默认情况下,Sphinx文档会输出格式化为双面打印的PDF.因此,标题页和TOC之间有一个空白页,TOC和介绍,介绍和第一部分等.
我的用户总是会在线查看PDF.所以我想删除这些空白页面.
这似乎是Sphinx中一个棘手的问题.查看此电子邮件主题.
这个用户提出了两个解决方案,但对我来说都不起作用 奇怪的是,第一个解决方案:
latex_elements = {
'classoptions': ',oneside',
}
给我
! Package babel Error: You haven't specified a language option.
第二种选择:
latex_font_size = '10pt,oneside'
运行,但生成的PDF只包含我的文档的奇数页.唉.
有没有人知道如何在没有这些空白页的情况下制作PDF？
我是使用sphinx的新手,第一次为python项目做文档.如何在sphinx文档中嵌入图像？
我在使用sphinx-build创建文档目录(html)时遇到了麻烦.
我试过了
sphinx-build -b html source build
以及
make html
但在这两种情况下,只生成html文件search.html,index.html和genindex.html.缺少modindex.html文件.
在我设置的conf.py文件中
html_domain_indices = True
所以我应该有一个modindex.html文件.我究竟做错了什么？构建html文件后,我没有收到任何错误消息.我在Windows XP上使用Sphinx 1.1.3和Python 2.7.
我正在使用FOP 1.0版来创建PDF.在其中一个页面中,我想显示一个图像(2552 x 4200像素),如果它不完全适合页面,则将其缩小.据我所知,在邮件列表中,建议的方法是:
<fo:external-graphic inline-progression-dimension.maximum="100%"
content-height="scale-down-to-fit"
content-width="scale-down-to-fit"
src="..."/>
不幸的是,仍然没有显示整个图像.图像的下半部分被切掉.任何人都可以给我一个关于我可能做错的提示吗？
我正在使用ECB(Emacs代码浏览器),我的默认布局如下:
;; +------+-------+--------------------------------------+
;; | | |
;; | Directories | |
;; | | |
;; +------+-------+ |
;; | History | Edit |
;; +------+-------+ |
;; | Methods | |
;; | | |
;; +-----------------------------------------------------+
默认情况下,方法按照它们在编辑缓冲区中出现的顺序显示,但我正在寻找一种按名称排序的方法.我想使用类似ecb-methods-sort-method但似乎不存在的东西.有关如何设置的任何提示？
我正在尝试使用sphinx autodoc扩展,特别是automodule指令自动生成我正在处理的django app的文档.问题是我想创建模块内不同类的内部引用,而不必在项目中的每个类/函数上使用autoclass和autofunction.对于像这样的源文件:
# source_code.py
class A:
"""docs for A
"""
pass
class B:
"""docs for B with
:ref:`internal reference to A <XXXX-some-reference-to-A-XXXX>`
"""
pass
我希望能够有一个像这样的sphinx文档文件:
.. automodule: source_code
我可以使用什么参考XXXX-some-reference-to-A-XXXX？有没有一种简单的方法来实现这一目标？在此先感谢您的帮助.
在 read-the-docs 上构建 Sphinx 文档失败，并显示以下错误（完整日志如下）：
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 上完成错误日志：
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: 2020-01-21T17:03:13.630658Z, duration: 0, exit-code: 0
git fetch origin --force --tags --prune --prune-tags --depth 50
From https://github.com/brunorijsman/cascade-python
2a28505..a7d50bf master -> origin/master
[rtd-command-info] start-time: 2020-01-21T17:03:13.824496Z, …