小编bar*_*ter的帖子

我目前正在使用sphinx创建有关我正在处理的python项目的完整文档。两种输出格式是HTML和Latex / PDF。

每当我创建一个嵌套列表时，父元素在html页面和PDF中都会显示为粗体。

例如：

#. aaaa
#. bbbb
    1. b1
    2. b2

渲染：

1. 一种
2. bbbb
   1. 11
   2. 22

在网上找到的所有嵌套列表示例中，情况并非如此。

有什么方法可以配置Sphinx使其父元素不加粗？

我正在使用Sphinx v1.2.3。这是我的conf.py：

    # -- General configuration ------------------------------------------------

autodoc_member_order = "bysource"



# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinxjp.themes.basicstrap',
    'sphinx.ext.pngmath'
] …

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

先感谢您!

是否可以以任何方式插入指向 reStructuredText 文件中锚点的 Markdown 文件的链接？

我有一个项目文档，其中也包含 .rst 和 .md 文件，并且我正在使用m2rr Sphinx 扩展，但它似乎只支持文件内的 rst 锚链接。

有什么办法可以实现这一点吗？

我想在我的KML中添加一个图例,无论你在地图上的哪个位置,它都会在同一个位置.你怎么做到这一点？叠加还是什么？非常感谢你

sphinx autoclass 指令生成的输出将 __init__ 的参数添加到类名的末尾。有什么办法告诉sphinx排除它们吗？我需要记录不应显式构造的类，因此 __init__ 参数是应从文档中省略的内部实现细节

我有一个很好的有关项目的狮身人面像文档，我想扩展它以生成诸如规范等文档。我希望有spec-for-foo.rst产生spec-for-foo.pdf

我正在使用 sphinx 记录我的项目，并使用 sphinxcontrib.napoleon 扩展，它允许我使用谷歌风格的文档字符串。

这是我的项目中的一个函数

def nn_normalized_weight(normweight_fn, qaid2_nns, qreq_):
    """
    Weights nearest neighbors using the chosen function

    Args:
        normweight_fn (func): chosen weight function e.g. lnbnn
        qaid2_nns (dict): query descriptor nearest neighbors and distances. qaid -> (qfx2_nnx, qfx2_dist)
        qreq_ (QueryRequest): hyper-parameters

    Returns:
        tuple(dict, dict) : (qaid2_weight, qaid2_selnorms)

    Example:
        >>> from ibeis.model.hots.nn_weights import *
        >>> from ibeis.model.hots import nn_weights
        >>> ibs, daid_list, qaid_list, qaid2_nns, qreq_ = nn_weights.testdata_nn_weights()
        >>> qaid = qaid_list[0]
        >>> #----
        >>> normweight_fn = lnbnn_fn
        >>> tup1 = nn_weights.nn_normalized_weight(normweight_fn, …

我是第一次使用“阅读文档” 。我正在为命令行系统编写文档，我的“代码示例”包括 shell 输出的日志。shell 输出最终看起来像这样

也就是说，服务（或者我对它的使用？）正在尝试将运行 shell 命令的示例格式化为源代码，并将 视为magento2:generate类常量。

我可以控制哪些代码块在阅读文档时获取源代码格式吗？我尝试在管理中不设置基本语言，但似乎没有效果。或者这是我需要在 sphinx 级别的 mkdocs 中控制的东西？（通过将 Markdown 或 sphinx 文件转换为漂亮的 HTML 文件来阅读文档）或者其他什么？还是我运气不好？

我们从Sphinx切换为样式NumPy文档字符串，并且.. sectionauthor::似乎无法正确呈现。但是，我们需要能够为一个类的每个方法分配一个作者。

有没有一种方法可以适当地向NumPy文档字符串添加作者身份？

一个简单的例子：

class A:
    def f(self):
        """ My function

        It does this and that.

        Returns
        -------
        object

        .. sectionauthor:: name of the author

        Examples
        --------
            >>> A().f()

        """
        pass

编译到此帮助文档中（注意问题返回：部分）：

PS .. sectionauthor::在NumPy docstring中建议在其他地方使用（无法回忆起源代码），因此也许根本就没有正确使用/放置它。

我可以用两种方式创建目录:

.. contents::
   :local:
   depth: 1

或者作为

.. toctree::
    :maxdepth: 1

    index

有什么区别？我应该在哪里使用toctree和内容？