我刚刚记录了我的代码,并学习了如何使用sphinx生成文档.我想将它包含在我的github项目页面中,但我不知道如何.有没有人知道现有的教程或简单的步骤呢？
谢谢.
我有一些代码和数据样本我复制到_static目录,我想链接到文档中的那些文件,如:
.. _pca-run.py: _static/example.data
但问题是sphinx没有为这个文件创建一个合适的相对链接,只是按原样复制值.因此,对于_static不在同一目录中的嵌套文件,链接不起作用.
我正在使用Sphinx为我正在开发的Python项目创建文档.我有三张图片,我想在一个1×3格(即所有在同一行)来显示,而我试图找出如何在新结构化做到这一点.现在我有
.. image:: _images/report_title.png
.. image:: _images/report_slide1.png
.. image:: _images/report_slide2.png
我想在一条线上试图围绕它们构建一个reST表,但这看起来有点荒谬.我如何对这些图像进行网格化？
我是狮身人面像的新手.我尝试了教程,但我没有在内容中生成链接.我得到的错误
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'intro' that doesn't have a title: no link will be generated
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'zuhdi' that doesn't have a title: no link will be generated
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.
Build finished. The HTML pages are in build/html.
我创建zuhdi.rst并intro.rst在同一目录中index.rst.如何将标题放在文件中？
为了您的信息,我的index.rst包含以下行: …
我创建了一个使用setuptools的演示项目,它具有以下结构:
project/
|- pizza/
| |- __init__.py
| `- margherita.py
|
|- README.rst
|- setup.cfg
`- setup.py
我正在尝试使用Sphinx自动生成此项目的文档.到目前为止,我已经尝试过:
# Generate a sphinx template
sphinx-quickstart
# Use default settings, except for project name, etc.
sphinx-apidoc -o source .
./setup.py build_sphinx
我觉得必须有到自动生成使用本文档更简单的方法README,setup.py和文档字符串.
最后,我想为另一个使用Python C-api的项目自动生成apidocs.我找不到任何东西.
我的主要问题是:是否有更简单的方法来自动生成此文档？
从文档中可以看出,双引号用于文字,而单引号则在有代码文本被解释时使用.
这将导致我为f()下面的方法编写docstring :
class A(B):
def f(arg1, arg2):
return B(arg1 + arg2 + self.index)
如:
Takes two arguments, ``arg1` and ``arg2``, which are assumed to be objects
of type (or duck-type) `NiceClass`, and returns a new object of class `B`
with `B.something` assigned some hash of ``arg1`` and ``arg2``.
这是正确的吗？
在许多代码示例中,Sphinx和其他方面,我看到相当于B并NiceClass用双引号括起来("``B``"和"``NiceClass``").
我无法弄清楚如何通过模板将变量导入Sphinx文档.我当然犯了一个基本的错误,但是虽然有很多关于使用Jinja/Flask模板进行Web服务的文档以及使用它的Sphinx的一些文档,但我在执行以下操作时遇到了麻烦.也许这是不可能的,我正在咆哮错误的树,但这与变量在Web(而不是doc)模板中的工作方式有很大不同？
我在一个更大的项目中工作.假设在我的项目中conf.py我做了一个变量,比方说
LANGS = ['en', 'de', 'cn']
我知道这是有效的,因为如果我做了docbuild(我们有一个自定义的docbuild,但我不认为除了定制的记录器以及吃了一堆'喋喋不休'之外它做了什么真的很疯狂) conf.py
print len(LANGS)
它出现在docbuild期间.
但是现在我想在我的模板中访问这个变量.据我所知,我们覆盖index.rst了templates/index.html,继承自Sphinx的基本layout.html.如果我这样做
<p>We have {{ LANGS|len }} languages</p>
我明白了
我们有0种语言
现在,这很奇怪,因为有时我可以通过引用未定义的变量(尽管不一致)来在构建中引起错误,因此它以某种方式'知道'变量已定义但认为它的长度为零.或者"null"变量是否自动为零？
如何定义此变量 - 或者不可能？
我想要做的就是为列表中的每种语言做一些事情(特别是制作一个外部链接),但我认为{% for %}/{% endfor %}如果我不能正常工作那么尝试或其他什么都没有意义.也许Sphinx只实现了Jinja的一个子集？
无论如何,请帮忙!
我正在使用Sphinx来构建我的文档.我正在使用其他工具进行API参考.我在目录中有我的文档,并且在其中的目录名api中有API引用.
我想要从文档到API参考的链接.我可以添加一个链接到我的toctree链接,所以:
.. toctree::
:maxdepth: 1
starting
glossary
main-use-case-flow
API Reference <http://www.example.com/lib/ios/0.1.0/api/>
问题是我不想放一条完整的路径,我想把它放在相对路径上 api/
如何使用相对路径而不是绝对路径链接到外部资源？
使用Sphinx for Python,如何避免在HTML中按字母顺序排序所有方法/函数名称？我希望它们保持与源代码中的顺序相同.
在我的Sphinx文档中,当我在重组文本中引用它们时,我想显示键盘键的图片.
例如,如果我说:点击Enter键.我想在线显示Enter键的图片,而不是单词Enter.
我在许多教程中都看到过这种图形,用于引用键盘按键,菜单选项等.他们是如何做到这一点的？我可以在Sphinx中这样做吗？