python-sphinx

20热度

1回答

我已经安装了Sphinx以便记录一些python模块和我正在处理的类。虽然标记语言看起来很不错，但我还没有设法自动记录Python代码。基本上，我有以下Python模块： SegLib.py ，并在其中被称为Seg的类。我想在生成的sphinx文档中显示类和模块的文档字符串，并为其添加格式化的文本。我index.rst看起来像这样： Contents: .. toctree:: :m

11热度

1回答

显示*仅*文档字符串狮身人面像文档

狮身人面像有一个叫做automethod功能，它可以提取方法的文档字符串的文件，并嵌入了入文档。但它不仅嵌入了文档字符串，还嵌入了方法签名（名称+参数）。我如何嵌入只有文档字符串（不包括方法签名）？裁判：http://sphinx.pocoo.org/ext/autodoc.html

53热度

6回答

什么是记录** kwargs参数的正确方法？

我使用sphinx和autodoc插件为我的Python模块生成API文档。虽然我可以看到如何很好地记录特定参数，但我找不到如何记录**kwargs参数的示例。有没有人有一个清晰的方式来记录这些的很好的例子？

6热度

1回答

django本地设置文档

我试图设置django。我确实有Django-1.1-alpha-1。我试图使用make实用工具制作位于Django-1.1-alpha-1/doc中的文档。但我收到的一些错误说法 > C:\django\Django-1.1-alpha-1\docs>C:\cygwin\bin\make.exe html mkdir -p _build/html _build/doctrees sp

6热度

3回答

狮身人面像（文档工具）：在输出中设置制表符宽度

如何在Pygments突出显示的Sphinx代码片段的HTML输出中设置制表符宽度？默认情况下，它是令人讨厌的8，但我想要4. 在Sphinx conf.py中找不到关于此设置的字样。

11热度

2回答

Sphinx/reStructuredText中表格的编辑器？

我正在寻找使用Sphinx/reStructuredText进行文档编制，它看起来非常有希望，除了表看起来像一个痛苦的事情。有没有可以提供帮助的编辑？

16热度

3回答

reST/Sphinx中的链接替换

我使用Sphinx来记录将部署在不同服务器上的web服务。该文档充满了用户点击的URL示例，它们应该可以正常工作。我的问题是主机，端口和部署根目录会有所不同，并且必须为每个部署重新生成文档。我试图定义换人是这样的： |base_url|/path .. |base_url| replace:: http://localhost:8080 但生成的HTML是不是我想要的（不包括在生成的链接

26热度

6回答

用于php代码文档的Sphinx

Sphinx是一个Python库，用于从一组ReST格式的文本文件生成漂亮的文档。不是用于全文搜索的工具我也完全了解doxygen/phpdoc工具。我试图弄清楚是否有一种使用Sphinx来记录php项目的方法？甚至是任何其他非Python语言？ http://sphinx.pocoo.org/

1热度

3回答

如何在Python文件无法编译时使用Sphinx自动文档

今天这个问题更加困难，因为我今天在Sphinx主页上没有使用过搜索功能。我有一组模块，我想从docstrings中记录。但是，这些不是纯粹的Python脚本。它们不会按原样编译，因为它们是从执行范围内创建新变量的C＃应用程序运行的。对于Python编译器，它看起来像我有一个未定义的方法（在技术上我是这样做的，直到C＃创建IronPython脚本引擎并创建该方法）。当我运行： sphinx

16热度

3回答

如何将从狮身人面像生成的html文档上传到github？

我刚刚记录了我的代码，并学会了如何使用sphinx生成文档。我想把它包含到我的github项目页面中，但我不知道如何去做。有没有人知道现有的教程或简单的步骤来做到这一点？谢谢。