使用ReST/Sphinx标记RESTful Web服务的方法/ URL的最佳方法是什么？是否存在适合使用可能的参数,HTTP方法,标题和正文内容标记URL的默认域？
有点像:
.. rest:method:: GET /api/foo
:param bar: A valid bar
:extension: json or xml
Retrieve foos for the given parameters. E.g.::
GET /api/foo.json?bar=baz
这样的事情是否已经存在或者是可用的默认扩展之一,还是我必须自己编写一个？
我在使用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.
在编写将使用Sphinx处理的RST时,我无法在引用数字时使用Sphinx LaTeX输出来使用图号.例如,这段代码:
The lemmings are attacking, as can be seen in :ref:`figlem`.
.. _figlem:
.. figure:: _static/lemming_invasion.*
They're coming!
将转换成这个:
旅行者正在攻击,正如他们即将到来的那样!
/ image到这里/
图1.1:他们来了!
但我想要的是"标准"LaTeX引用数字的方式,如下所示:
旅鼠正在攻击,如图1.1所示
我该如何实现这一目标？我目前使用的代码是Sphinx手册推荐的代码,但它不会产生我想要的输出.
我想使用sphinx的autodoc-skip-member事件来选择某个python类中的一部分成员来获取文档.
但是从sphinx文档中不清楚,我找不到任何说明的例子:我在哪里放置代码来连接它？我看到Sphinx.connect,我怀疑它在我的conf.py中,但是当我在conf.py中尝试使用这些代码的变体时,我找不到应该连接的应用程序对象():
def maybe_skip_member(app, what, name, obj, skip,
options):
print app, what, name, obj, skip, options
return False
# This is not even close to correct:
#from sphinx.application import Sphinx
#Sphinx().connect('autodoc-skip-member', maybe_skip_member)
指向一个简单示例的指针是理想的.
在这个reST示例意味着由Sphinx呈现,| yaco_url | 不会被替换,因为它在代码块中:
.. |yaco_url| replace:: http://yaco.es/
You can use wget to download it:
.. code-block:: console
$ wget |yaco_url|package.tar.gz
我想知道是否有某种方法可以强制更换| yaco_url | 在渲染代码块之前.
我想在标题和段落之间以及段落之间留出更多空间.我不希望这是一个全局设置,但我想在需要的地方和时间使用它.感谢任何建议.
Sphinx是一个Python库,可以从一组ReST格式的文本文件生成很好的文档.不是用于全文搜索的工具
我也完全了解doxygen/phpdoc工具.我想弄清楚是否有办法使用Sphinx来记录php项目？甚至任何其他非python语言？
我正在构建一个Python包,并使用Sphinx来创建文档.除了我的包代码,我还包括很多使用argparse的命令行Python脚本.我想知道是否有办法让Sphinx自动记录这些脚本？最终目标将是一个漂亮的脚本列表,以及相关的帮助打印,参数和选项.要清楚,我正在寻找一种预先存在的方法来做到这一点,而不是自己实现这一点的方法.
这并不像我通常所问的那样具体,如果有更合适的SE网站发布这个问题,请告诉我.谢谢.
使用sphinx的自动模块时(http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule),
我只是写一个.rst文件:
.. automodule:: my_module
:members:
它记录了my_module,但它没有找到像my_module.inner_module0和my_module.inner_module1这样的内部模块.除了__all__变量之外,是否还需要在__init__.py文件中指定某些内容？
另外,我知道sphinx-apidoc.但是这个命令文件太多了(暴露了每个函数/文件夹,包括未记录的文件).