标签: python-sphinx

我想知道为什么在 Sphinx 中使用 automodule 指令时我看不到类属性......即使属性有文档字符串。

与 Django 设置 CONSTANTS 相同，它们没有显示。

我用：

.. automodule:: settings
   :members:
   :show-inheritance:
   :undoc-members:

我将设置拆分为模块

设置

• _初始化_.py
• installed_apps.py
• 语言环境.py
• 数据库文件
• 缓存文件
• stage_stable.py
• stage_test.py
• stage_dev.py
• ...
• 模板.py

并在__init__.py我从其他文件导入所有内容并选择我所在的阶段。

它适用于 Django，简化了设置修改和...不适用于 Sphinx。

在可行的情况下,我喜欢在版本控制下拥有构建所需的工具.理想的情况是,在任何需要首先安装最少工具的机器上运行新的结账.

将Python置于版本控制之下是否可行？

python包怎么样？由于对Docutils的依赖,我在没有安装它的情况下尝试使用Sphinx失败了.有没有办法在没有安装的情况下使用它？

from docutils.parsers.rst.directives.images import Figure
class MyFigure(Figure):
    def run(self):
        # here I need to read the 'thumbnails_folder' setting
        pass

def setup(app):
    app.add_config_value('thumbnails_folder', '_thumbnails', 'env')

如何访问 中的配置值.run()？我阅读了 Sphinx-contrib 的来源，但没有看到以我的方式完成的事情，所以他们conf.py以我不能的方式访问。或者我应该以不同的方式来做？

我想做的就是翻译这个

.. figure:: image/image.jpg

进入这个：

.. image:: image/thumbnails/image.jpg
   :target: image/image.jpg

这是扩展代码

（缩略图是用 PIL 生成的）。并将其:target:放入可下载的文件中（如我所见，只有构建器实例才能执行此操作）。

如何启用MathJax扩展mhchem的Sphinx？MathJax 是从CDN.

我已经为我的项目安装了 django sphinx。成功安装和 sphinx 快速启动操作后，我尝试使用命令“make html”在“build”文件夹中创建 html，它给了我错误“make: * No rule to make target `html'。停止。”。任何帮助..提前致谢。

我很好奇是否可以在django应用程序中隐藏sphinx文档,以便只有登录的人才能看到它.在我看来,由于sphinx创建了自己的结构,并且Django使用urlconf来定义用户可以看到的页面,因此无法将两者合并.虽然Django网站可能会使用django和sphinx,但必须有一些组合.我想知道是否有人有任何见解,或者他们是否可以指出我正确的方向.

先感谢您!

我正在使用 sphinx 和 read-the-docs 主题创建 html 文档。当我添加缩放图像时，可以单击它并在新选项卡中弹出全尺寸。如何禁用此行为。

例如，我在整个文档中使用以下场景 1) 创建一个 png 文件，例如 application-icon.png ，大小正好为 10pt x 10pt。2）创建一个包含以下内容的文档：

.. |应用程序_图标| 图像::图像/应用程序图标.png

：宽度：10pt

：高度：10pt

单击应用程序图标 |application_icon| 显示 …”

当包含宽度和高度比例信息时，即使我在手机上查看文档，图标也会显示完美且正确的大小。但是，该图标是可点击的，并会打开一个显示图像的新选项卡。如果我省略了比例信息，图标将不再可点击，但是在我的手机上打开文档时图像不会缩放，而是占据了手机屏幕的整个宽度。

几天前我开始使用 Sphinx 来记录一个 python 包，我得到了一个似乎是常见的错误，但我找不到解决方案。

我使用 sphinx-quickstart 来设置一切。我使用“doc/”作为文档根位置。包含我的包的文件夹设置为：

myfolder/
    doc/
    mypackage/
        __init__.py
        moprob.py
        ...

快速启动后，我将 conf.py 中的路径编辑为：

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

然后我将包中的一个脚本添加到 index.rst 以查看 sphinx 是如何工作的。

 .. toctree::
   :maxdepth: 2
   :caption: Contents:

   mypackage/moprob

我得到的错误代码：

.../index.rst:9: WARNING: toctree contains reference to nonexisting document u'mypackage/moprob'

我尝试过的解决方案：

1. 将 sphinx.ext.napoleon 添加到扩展列表中，因为我的所有文档字符串都是使用 numpy 格式编写的。错误并没有消失。我还将拿破仑扩展名放在 autodoc 之后，因为其中一个帮助页面建议了这一点。

   扩展 = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']

2. 将 numpydoc_show_class_members = False 添加到 conf.py。我把它直接放在扩展下面。这也没有帮助。

3. 文件夹位置的几种不同配置。我还尝试将根位置设置为 myfolder，将源设置为 mypackage，将构建设置为 doc。没有一个奏效。

你有什么想法可以帮助我吗？

我正在使用 sphinx 尝试从 .rst 文件创建 HTML 文档。我正在尝试创建一个具有编号列表 (1., 2., ...) 的文档，其中包含一个显示示例代码的嵌套子列表 (a., b, c., ...)。但是我在梳理语法以使嵌套子列表起作用时遇到了麻烦。这.rst是我尝试过的示例文件：

===========
Tester Page
===========

Below are some test paragraphs.

1. This is a paragraph detailing a higher level step, with 3 sub-steps.
 a. This is a sub-bullet, with an example:
::

    ls -l foo.txt

 b. I can't get this line to not display as part of the code block! This is another sub-bullet, with an example:
::

    git add bar.txt

2. This is …

似乎有两个地方可以为一个类放置docstrings:

1. 在类定义下:

class MyClass(object):
     """ Summary of MyClass

     Body

     ...
     """

2. 在__init__构造函数下面:

...
    def __init__(self, arg1, arg2):
        """ Summary of MyClass

        Body

        ...
        """

哪个更受欢迎？或者两个都可以吗？