标签: python-sphinx

我该如何运行它？

我想将Sphinx用于我自己的项目,为此我想创建一个新的sphinx 域.但是我开始时遇到了严重的麻烦.我的最小sphinx域只允许一条名为'command'的指令:

.. xx:command:: Somecommand

我找不到任何关于在互联网上编写sphinx域名的介绍,只有一些准备好为ruby,erlang等运行域名.有人可以告诉我如何开始吗？

在Python 2.5上,我安装了sphinx easy_install,它可以在Windows 7上的以下位置使用:

C:\Python25\Lib\site-packages\sphinx-1.0.8-py2.5.egg\sphinx

我想将几个.rst文件转换为HTML.但每当我这样做时,我会sphinx-build遇到以下错误:

'sphinx-build' is not recognized as an internal or external command,
operable program or batch file.

我错过了什么吗？

我正在尝试使用Sphinx进行python文档生成.问题是sphinx-build最终会执行模块/评估全局范围内的任何内容.它有这样做的原因吗？有没有人知道可以设置为禁用此标志的标志？

似乎Sphinx试图进行代码覆盖或类似的东西,这绝对不是我想要的.通常这不是问题,但是一组特定的模块非常特定于环境.

我有一个sphinx格式的docstring,我想从中提取不同的部分(param,return,type,rtype等)以供进一步处理.我怎样才能做到这一点？

如何在重组后的文本中生成方程式，然后加上方程式编号：

p = f(x)                (1)

.. math::
   p = f(x)

只会导致：

p = f(x)

我用make latexpdf命令通过Sphinx创建了一个文档.

现在我遇到的问题是,LaTeX在文本后面直接将我的图片设置在顶部,而在图像的底部则设置了3或4个换行符.

是否有可能在图片底部获得1个空格,在图片底部获得1个空格而无需 \在语法中使用？

我的代码:

title:
===========

some text

.. image:: screenshots/manage_products.png

some more text

another title:
===========

编辑:这里有一个小屏幕截图,向您展示我的问题.我还查看了Sphinx的主要文档(+语法文档),但没有找到这个问题的答案!

顺便说一句:忽略红色箭头plz.

我有很多Sphinx页面，它们的链接相同。像那些：

.. _CC-BY: https://creativecommons.org/licenses/by/3.0/
.. _MIT: http://opensource.org/licenses/MIT

目前，每个文件中都有这两行MIT_。在项目中是否可以有一个中央文件，我可以在其中放置那些链接目标？这样，我可以MIT_在任何地方写东西，并且可以链接到那个地方。

让我们考虑以下功能：

def format_send_event(self, message_identifier, payload=""):
    """
    Format a SendEvent.

    :param message_identifier: Message identifier (defined in the :py:module:`MyModule.constants` file).
    :type message_identifier: int
    :param payload: Payload of the message.
    :type payload: str
    """
    # Do something

使用sphinx-build进行编译时，出现以下错误：

...MyModule/handlers.py:docstring of MyModule.handlers.MyClass.format_send_event:3: ERROR: Unknown interpreted text role "py:module".

看起来sphinx-builder无法理解该标签:py:module:。

在Sphinx中用于引用模块的标签是什么？

我试图找出如何使用Sphinx中的_template覆盖选项覆盖默认的ReadTheDocs主题,以便在http://readthedocs.org上托管Sphinx文档.

具体来说,我想要删除/隐藏此主题右上角显示的"在Github上编辑"链接.

任何提示将非常感谢!谢谢!

我在这里查看了文档:http://www.sphinx-doc.org/en/stable/templating.html但是,我很难过,真的需要一些帮助.

谢谢!