Sphinx文本包含指令中的缩进块
是指在Sphinx文档中使用缩进来创建代码块或引用文本的一种语法规则。缩进块在Sphinx文档中可以用于展示示例代码、命令行输入输出、引用文本或注释等。
在Sphinx中，可以使用"::"语法来创建一个缩进块。在"::"之后，需要使用适当的缩进来标识出代码块的起始和结束。代码块中的内容可以是任何文本，包括代码、命令行输入输出或文本段落等。
缩进块在Sphinx文档中的应用场景非常广泛。它可以用于演示示例代码的用法和结果，方便读者理解和学习。同时，它也可以用于展示命令行输入输出，特别适用于介绍命令行工具的使用方法。此外，缩进块还可以用于引用外部文本、注释或者说明性的文字，提供额外的参考信息。
在腾讯云的产品生态中，相关的产品和服务可以推荐以下几个：
- 腾讯云服务器（CVM）：提供弹性的虚拟云服务器，支持多种操作系统和实例规格，可满足不同业务场景的需求。详情请参考：腾讯云服务器产品介绍
- 腾讯云云数据库MySQL版（TencentDB for MySQL）：提供高性能、可扩展的关系型数据库服务，支持自动备份、读写分离等功能，适用于各种规模的应用。详情请参考：腾讯云云数据库MySQL版产品介绍
- 腾讯云对象存储（COS）：提供安全、稳定的云端存储服务，适用于图片、音视频、文档等各类文件的存储与管理。详情请参考：腾讯云对象存储产品介绍
以上是腾讯云的一些相关产品，可以根据具体的业务需求选择合适的产品进行使用和部署。请注意，以上链接只是产品介绍页面，具体的使用和部署方法可以参考腾讯云的官方文档和开发者资源。
相关·内容
1回答
我希望在两个节标题之间显示两个函数的docstring，如下所示：
===
API
===
.. autofunction:: parsons.aws.distribute_task
.. autofunction:: parsons.aws.event_command
***
S3
***
这两个文档字符串都出现在呈现的HTML中，但是第二个函数也将Sphinx指令.. autofunction:: parsons.aws.event_command显示为docstring下面的文本：
对于为什么会发生这种情况，以及我如何摆脱它，有什么想法吗？
您可以在GitHub文件的顶部
浏览 2提问于2020-10-08得票数 1
回答已采纳
1回答
我有一个README.rst我用Sphinx渲染的文件。在那里面.rst我在文件末尾看到以下两行： .. substitutions
.. |banner| image:: docs/source/logo/Banner.png 我试着找出这句话.. substitutions但是我什么也没找到。 如果我删除这行.. substitutions sphinx命令给出一个警告 Problem with "end-before" option of "include" directive:
Text not found. 并且不呈现该页面。 有什么想法可以找到
浏览 39提问于2021-02-23得票数 2
回答已采纳
我正试图用狮身人面像来构建文档，却找不出如何使用:noindex:。
设置
我使用以下扩展：
extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.autodoc",
"sphinx_rtd_theme",
"m2r2",
]
我的.rst文件包含了从autodoc生成文档的这个例程：
.. automodule:: squ
浏览 2提问于2021-03-21得票数 4
回答已采纳
我只需要在reStructuredText (sphinx)中嵌入一小段超文本标记语言或xml，这样浏览器就可以在生成的超文本标记语言文件中呈现它们，如下所示
.. raw:: html
<a href="testurl">testurl</a>
或
.. raw:: html
<math><apply><plus/><ci>a</ci><apply><minus/><ci>b</ci><ci>c</ci></
浏览 55提问于2018-05-28得票数 3
在Sphinx ( ReStructuredText发布系统)中，是否有任何模糊的规则来限制文字块可以包含的内容？
背景:我的文档包含许多跟在双冒号段落后面的文字块，如下所示：
Background:... follow a double-colon paragraph, like this::
$ sudo su
# echo ttyS0,115200 > /sys/module/kgdboc/parameters/kgdboc
这个块(前面有不同的段落)是发出错误的块之一：“警告:不一致的文字块引用。”该消息指示错误在"echo“行中。在HT
浏览 1提问于2021-01-28得票数 0
1回答
我想在我的sphinx文档中添加一个菜单"todo items"，它应该包含我的项目的所有方法，其中包含一些todo项，如下所示： “：todo:函数àimplémenter” 我想要显示类的名称、相关方法的名称、行号及其内容。 我发现了一些可能相关的东西：http://www.pythondoc.com/sphinx/ext/autodoc.html#skipping-members，但它只过滤方法，似乎没有链接到所需的信息(行号和行内容)。 有没有办法做到这一点？你知道一些有用的链接吗？
浏览 50提问于2019-07-03得票数 0
有没有办法在Sphinx中只包含特定文档的CSS样式表？
我正在尝试使用来自此的自动编号建议。但是，由于我想创建一个更大的文档，所以我只需要对某些文档进行编号。因此，我只想在特定的rst文件中包含所呈现的CSS文件。这可能吗/有人知道如何做到这一点吗？
浏览 0提问于2016-10-31得票数 0
我有通过包含数学块的狮身人面像文档。默认情况下，它们以HTML输出为中心。我希望它们都在左边对齐，但对周围的文本有一些缩进。
例如，如果是在index.rst中
For :math:`|r| < 1`:
.. math::
\sum\limits_{k=0}^{\infty} r^k = \frac{1}{1-r}
Text in following paragraph put here to demonstrate that the math block
is in fact centered on the page.
conf.py完全为空，然后在同一个文件夹中运行sph
浏览 19提问于2021-12-14得票数 0
回答已采纳
假设我正在为我的RestructuredText/Sphinx编写一个自定义编辑器，带有"live“html输出预览。输出是使用Sphinx构建的。 源文件是纯RestructuredText。那里没有代码。 一个理想的特性是，右键单击预览的某个部分，将在源文件的正确行打开编辑器。 为了实现这一点，一种方式是将行号放入html文件的每个标签中，例如使用类(例如，class = "... lineno-124")。或者使用html注释。 请注意，我不想在源文件中添加更多内容，只希望在输出中的任何地方都包含行号。 大致的行数就足够了。 有人知道如何在Sphinx中做到这一
浏览 30提问于2019-09-18得票数 1
1回答
我正在努力弄清楚如何让doctest与Sphinx一起工作，但它似乎并没有找到我的测试。下面是一个简单的例子。
def my_func():
'''
Dummy test function. Returns the number 5.
.. doctest::
>>> my_func()
5
'''
return 5
当我运行make doctest时，输出告诉我没有测试。我很确定我的配置是正确的，因为如果我运行make html，然后转到我的index.html文件，我
浏览 2提问于2017-09-28得票数 1
回答已采纳
我正在用RST编写文档，并使用Sphinx生成HTML。
我想注释掉一些文本，但是HTML正在插入一个空行。
* Line1
.. * Line2
* Line3
* Line4
HTML在Line1和Line3之间打印空行。如何删除此空行？
浏览 0提问于2017-03-16得票数 1
回答已采纳
如果代码块：：没有可选参数，Sphinx highlight_language配置选项的意义是什么？
它说它设置了默认的hightlight_language，但是如果每次指定代码时都需要声明语言，为什么它需要配置选项？
我做错了什么吗？
编辑:当我删除代码块的参数时，从日志中删除。
C:\c\Sponge\SpongeDocs\source\plugin\scheduler.rst:25: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
浏览 3提问于2016-01-12得票数 9
回答已采纳
1回答
我有一个重构的文本文档，其中有几个层次结构部分，例如：
Main title
##########
Text under the main title.
Sub-section
===========
Text under the sub-section.
这很好用，当我使用Sphinx编译它时，我得到了正确的HTML格式。
我的问题是:如何才能提升层次结构级别，以便可以在几个子部分之后添加更多文本？
例如：
Main title
##########
Text under the main title.
Sub-section
===========
Text under the
浏览 3提问于2015-03-02得票数 0
有没有办法用Sphinx在rst文件中渲染MathML？
我在conf.py中启用了mathjax扩展。它使用like与latex配合得很好
但是，如果我用数学ML替换它，它确实会呈现它，但会显示所有的xml代码。例如,
产生
在Sphinx中，数学是由mathjax扩展呈现的。在上，mathjax声称他们支持MathML。
浏览 1提问于2018-05-26得票数 3
2回答
Contents:
.. toctree::
:maxdepth: 2
foo.rst
bar.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
我试图使用sphinx-build . doc构建它，它给了我警告：
(警告/2)树引用未知文档u‘’bar‘
可能是什么原因？
浏览 5提问于2010-12-13得票数 4
1回答
我对狮身人面像的restructuredText输入文件有很长的一行：
This is a long line text that I want to keep as a long single line. It should not be wrapped in the text output.
使用Sphinx的文本生成器，我得到了以下输出：
This is a long line text that I want to keep as a long single line. It
should not be wrapped in the text output.
狮身人面像包裹着这条线。我
浏览 0提问于2018-05-10得票数 1
我在一个板条箱中有以下注释代码：
/// Complex Expression
///
/// - The `Undefined` variant is used as a placeholder during code
/// transformations. It must never occur in the final result.
pub enum Cexp {
Undefined,
Unimplemented,
}
在机箱上运行cargo test时，它会触发doctest运行，无法编译。(在中，确保运行测试而不是构建。)
Doc-te
浏览 0提问于2019-07-23得票数 5
我正在使用Sphinx为我的项目生成文档，并将构建文档作为产品安装过程的一部分。
我希望在文本和/或代码块中动态包含主机名。我在文档中没有看到任何解释，也没有看到任何工具来包含shell命令的输出，或者除了特定文件中的特定行之外的任何内容。此功能是否存在？
浏览 1提问于2013-04-18得票数 9
回答已采纳
我从命令行运行sphinx-build命令来构建latex和html文档，因为它们具有相同的源.rst文件： $ sphinx-build -b html <source> <output> $ sphinx-build -b latex <source> <output> 但是，对于latex输出，我想忽略所有的"include“指令。 这可以通过在与sphinx的conf.py相同的目录中添加一个包含以下内容的docutils.conf文件来完成： [parsers]
[restructuredtext parser]
file-i
浏览 19提问于2019-05-27得票数 1
我正在使用Sphinx来管理我的项目文档。
我有一个无序列表，我希望每个项目的第一行都是一个代码段。(不是内联，而是段落。)
我该怎么做呢？
浏览 0提问于2010-11-30得票数 4
回答已采纳
1回答
有没有可能让Sphinx基于文本中的现有标签和:ref:生成索引？假设你有一个标签： .. _my_label:
My Section 然后通过多个:ref:`my_label`引用它，有没有办法获得等同于自动生成的： .. index:: My Section 标签在哪里，:ref:所在的段落之前也是一样吗？ 官方文档没有将labels或:ref:列为index-generating markup，我也找不到任何这样做的扩展。但也许真的有呢？
浏览 9提问于2020-09-25得票数 1
回答已采纳
2回答
我使用的是安装了Apache6.4的CentOS 6.4。我有一个名为cmsSearch.php的php文件。在文件的顶部，我有一个执行良好的PHP (查询Sphinx搜索索引)。但是，我试图在下面的HTML中运行的任何php (试图运行foreach并使用Sphinx搜索的结果填充表)只要在控制台(Chrome)中查看页面时就会被注释掉。下面是整个cmsSearch.php文件：
<?php
require("sphinxapi.php");
if($_POST['keyword'])
{
$keyword = $_POST['keyword&
浏览 3提问于2013-09-18得票数 3
回答已采纳
2回答
我想在docstring中创建一个目录树，并且在不更改我的Sphinx文档的情况下将它呈现出来，但是我遇到了麻烦。我试过使用:单、双和三次回标；文字:code:；和文字.. code-block:: python来使其工作。我认为后两者没有工作，因为这个块也是无效的Python/代码。此外，我还改变了缩进和间距的数量和类型，但没有用。
下面是我的示例(使用三条倒钩来描述所讨论的块)。因此，我的问题是-如何呈现从docstring到Sphinx的块，就像docstring中所示的那样？基本上，我想关闭标记片刻，并呈现管道和缩进，就像在文本文件中一样。
为了充分披露信息，我确实找到了，但在他们要求
浏览 0提问于2018-06-19得票数 9
回答已采纳
3回答
我使用的是Sphinx，我真的很喜欢它，但它不能提取模块概要。没有错误或任何东西，只是简单的.没什么。这是我试图自动创建文档的模块：
# vim: set fileencoding=utf-8 :
"""
.. module:: CONF
:synopsis: Configuration module, tells where data files are.
.. moduleauthor:: Mr Anderson <mr@matrix.com>
"""
这是ReST索引文件中的Sphinx指令：
.. automodule
浏览 1提问于2013-01-16得票数 5
5回答
Sphinx是一个Python库，用于从一组ReST格式的文本文件生成漂亮的文档。不是用于全文搜索的工具
我也完全了解doxygen / phpdoc工具。我想知道有没有办法使用Sphinx来记录PHP项目？或者其他任何非Python语言？
浏览 0提问于2009-11-18得票数 27
我目前正在使用python开发一个复杂的文档项目。我的下一步是启用国际化。
项目概览(简化)：
doc\
build\ # contains sphinx build output
images\ # contains image resources
locales\ # gnu gettext structure (simplified)
en\LC_MESSAGES\index.po+mo
en\LC_MESSAGES\articles\connect.po+mo
de\LC_MESSAGES\index.po+mo
de\LC
浏览 10提问于2022-04-06得票数 0
回答已采纳
我会在reStructuredText中自动编号代码块，如果自动编号是不可能的，然后手动命名/编号。
.. code-block:: python
:name: super awesome code exaple no 5
a = 1
在训练时，我们可以参考它们，并告诉学生我们现在正在努力的例子。我们不需要在文档本身中引用它们。
有没有可能呢？是开箱即用还是通过扩展Sphinx？
浏览 0提问于2014-09-23得票数 1
1回答
考虑以下最小的示例：
docs/index.rst
* :ref:`modindex`
docs/modules.rst
exampleproject
==============
.. toctree::
:maxdepth: 4
exampleproject
.. print_notes_attached_to_topic::
:topic: notes_about_someproblem
docs/conf.py
extensions = ['sphinx.ext.autodoc']
docs/exampleproject.rst
example
浏览 0提问于2021-09-10得票数 1
回答已采纳
在我正在编写的一些sphinx文档中，我包含了一个辅助文件中的代码示例，如下所示：
.. literalinclude:: mymodule.py
:pyobject: MyClass
:linenos:
这个特别的文档是一个教程，其中的类是逐步构建的。我想要做的是包含整个类或单个方法，并且只强调对该部分感兴趣的行。这样就保留了上下文，但有趣的部分一目了然。现在，我已经求助于只引用文本中的行号，这是可以的，但离理想还很远。
查看sphinx和pygments的文档和代码，我找不到一种明显的方法来做到这一点。我并不反对在conf.py中打补丁或做一些棘手的事情，但我想知道是否有人已经
浏览 0提问于2010-03-19得票数 9
3回答
如何获得rst中粗体的代码(单空间)文本(我正在使用Sphinx)？::中的任何内容似乎都是按照字面意思呈现的，就像, so**粗体**不起作用一样。
浏览 2提问于2014-10-14得票数 8
回答已采纳
这是"ReST删除线“的后续，但在Sphinx而不是ReST上下文中。我的问题是，在sphinx中是否有一个中心位置来放置“角色”指令，或者这个指令是否真的必须在sphinx文档中的每个rst文件中重复。
更详细地说：
使用role指令很容易为内联文本定义自定义CSS样式(请参阅ReST删除线作为示例)：
.. role:: custom
:class: custom
This is an :custom:`inline text`.
转换为html呈现的
.. This is an <span class="custom">inline text&
浏览 1提问于2012-03-14得票数 25
回答已采纳
在用sphinx-apidoc.生成RST文件时，无法正确添加__main__.py文件及其函数其他文件和类是正确生成的。
只有当我使用包含私有模块的-P参数运行sphinx时，我才能工作。但是我不想添加其他模块的私有方法，我只需要从__main__.py获得这些方法。
__main__.py看起来是这样的：
def main():
"""
main() description here
"""
f1()
f2()
if __name__ == '__main__':
main()
浏览 0提问于2019-01-11得票数 1
回答已采纳
1回答
在sphinx文档的RST中，并使用数学方程的sphinx.ext.imgmath扩展，我想在项目点列表的中间添加一个方程，但在该方程之后有第二段，并保持符号点的缩进水平。我认为，除了math之外，任何其他类型的指令都会出现同样的问题。
我当前的RST代码如下所示：
Introducing the bullet list on zero-th level indentation:
- First bullet point on first level indentation.
.. math::
centered math equation
I would like this t
浏览 4提问于2022-05-24得票数 1
回答已采纳
我想包括斯芬克斯的乳胶医生。sphinx构建不包括使用.. raw:: latex指令链接的latex文件。我有过
这是我的dir结构
docs/
source/
importlatex.rst
index.rst
build/
tex/
texfile.tex
index.rst看起来就像
Welcome to documentation!
=========================
Contents:
.. toctree::
:maxdepth: 2
icnludelatex
and-
浏览 3提问于2017-07-12得票数 6
4回答
如果我有字典的话：
{
"cats": {
"sphinx": 3,
"british": 2
},
"dogs": {}
}
尝试将其保存到文本文件中，我得到如下内容：
{"cats": {"sphinx": 3}, {"british": 2}, "dogs": {}}
我怎样才能把字典保存得很漂亮，这样就很容易被人看懂了？
浏览 2提问于2016-03-19得票数 6
回答已采纳
我在GitHub上有一个README.rst，它也被合并到一个Python项目的Sphinx生成的文档中。我想在文件的顶部添加一条注释，该注释将显示在GitHub上(它只是呈现.rst)，但不会显示在由Sphinx生成的文档中。
我知道可以使用.. blah blah blah在.rst文件中包含注释，但是有没有什么方法可以包含只被Sphinx视为注释的行呢？(或者，让Sphinx忽略该行。)
浏览 0提问于2016-03-07得票数 3
1回答
我正在编写许多Sphinx/RestructuredText，其中包括使用PlantUML的序列图。我有很多我正在重用的文本，所以为了让事情变得更简单，我创建了一个definitions.iuml文件。在这个文件中，我可以创建命名文本引用(通过!startsub/!endsub块)，允许我在几个不同的序列图中引用它们。在源位置更改一次，它们都会更改。太完美了。
我的问题是如何在序列图之外使用这些引用？--我在.rst文件中使用了完全相同的代码(!includesub ../defintions.iuml!NAMED-REFERENCE)，当我制作docx/pdf时，我看到了这个链接，我没有看到
浏览 7提问于2022-01-27得票数 -1
我是Sphinx的新手，我似乎没有找到实现这一点的方法。我希望能够在进行过程中快速注释/取消注释单个toctree条目，而不必删除行。我使用Latex来做这件事，以便在我的项目仍在进行中时减少编译时间。 例如，我想要实现这样的结果： .. toctree::
file1
file2
.. file3 (I want to comment/uncomment this, easily)
file4
.. file5 (this also fails)
..
file6 (this also fails) 什么才是正确的方法呢？
浏览 58提问于2021-04-02得票数 0
回答已采纳
我试图找到关于Sphinx将某些文档标记为“内部”并像sphinx-build -b -include internal source output一样构建文档的能力的信息，其中-include标志将包含一系列要包含在输出中的标记。
这将允许我生成两个版本(或更多)的我的文档，同时保持它的单一来源。
示例：
.. audience::internal
Page title
============
This whole page will be available only in the internal docs.
或
Page title
============
This whol
浏览 2提问于2017-05-12得票数 2
回答已采纳
我正在使用Sphinx来记录python项目，并尝试创建一个可重用的提示，以便在多个位置使用。
通常，我将在python文件中使用以下语法：
"""
.. tip::
I want this tip to be used in several locations. Why?
- Save time
- Work less
"""
现在，不管我把它放在文件的开头，还是在类定义下，还是在函数定义下，这都是可行的。
我找到了 for :ref:，它建议使用标签：
.. _my_reusable_tip:
浏览 2提问于2015-12-03得票数 1
回答已采纳
我正在使用Sphinx创建这个表：
+---------------+---------------------+---------------------------+-------------------------------------+---------------------+
| Stakeholder | Major Value | Attitudes | Constraints | Major Interests |
+===============+=========
浏览 1提问于2014-12-18得票数 7
1回答
我正在用重新构造的文本( Sphinx页面)和Python模块中的内联文本编写代码文档。什么是拼写检查书面文档的好方法
拼写检查器将知道重新构造的文本语法，并跳过例如链接，而不是将它们突出显示为拼写错误。
拼写检查器可以与文本编辑器集成在后台运行(崇高文本)
浏览 3提问于2015-02-05得票数 2
我最近开始在我的项目中添加文档，我正在尝试遵循Google风格指南。我使用Sphinx生成文档，使用Sphinx扩展napoleon来弥合Google styleguide和reST之间的鸿沟。
呈现params和Notes没有问题，但我似乎不能让示例部分呈现代码片段。
class Chicken(object):
"""Animal that lays egg and has feathers
Note:
Chickens love to eat feed
Example:
浏览 2提问于2017-06-16得票数 5
我如何将代码嵌入到docstring中，告诉Sphinx将代码格式化为类似于Markdown (不同背景颜色、单频无字体)的代码？例如，记录代码使用示例。
""" This is a module documentation
Use this module like this:
res = aFunction(something, goes, in)
print(res.avalue)
"""
浏览 5提问于2020-10-20得票数 5
回答已采纳
1回答
我正在使用Sphinx为我的项目编写文档，并发现下面给出的两个相似的reStructuredText片段的呈现方式存在差异。
示例1
Some text:
* Item 0
* Item 1
* Item 2
::
Some code
Some code
Some code
Some code
.. WARNING::
Some text.
* Item 3
示例2
Some inline text:
* Item 0
* Item 1
* Item 2
::
浏览 0提问于2013-06-03得票数 7
回答已采纳
我正在记录，但无论是Appledoc还是Doxygen，我都没什么好运气。。关于这个问题，我想把重点放在氧气问题上。
如果接口中的代码片段也包含一个接口或协议，also将扼杀(忽略)类级intro -我指的是在@接口上方发生的所有比特。。。为了正确地记录这个类，我们确实需要这些片段。
是否有办法使doxygen将这些代码段视为代码片段和普通代码片段，而不删除类概述？
我试过用一些~~栅栏符号，但这行不通。
下面是它的内容。
浏览 3提问于2013-12-06得票数 0
回答已采纳
2回答
如何将本地目录包含到Sphinx文档中？
我试过了
.. toc::
但这似乎没有任何效果:文档中没有插入任何内容。
基本上，我需要链接到当前页面的部分，以放置在每个页面的某个位置。
这个是可能的吗？
浏览 3提问于2014-06-10得票数 59
回答已采纳
我在我的raw文件中包含了一个rst指令：
.. raw:: html
< html here >
在HTML中，有一个动态放置的字符串，其中包含reStructuredText。因为它被放置在raw指令中，所以它不会呈现为reStructuredText，而是保持为reStructuredText。
因此，如何访问sphinx的呈现函数，使我能够手动生成raw指令之外的HTML？
我读了几个狮身人面像的文件，但我可能缺乏一些基本的信息。
我的理解是：
jinjia用于模板的呈现，而不是文件的转换。
狮身人面像有各种构建器，其中一个是html构建器(例如make h
浏览 0提问于2018-09-12得票数 0
回答已采纳
我有一个RST文件，我不希望任何语法突出显示。它包含多个文字块和文件顶部的一个突出显示指令，试图禁用语法突出显示：
.. highlight:: none
::
Text that happens to contain words like list, None, etc.
::
Another literal block with words like list, None, etc.
该项目中的其他一些RST文件使用语法突出显示和指令，如下所示：
.. highlight:: bash
当我在工作站上用sphinx构建文档时，sphinx正确地突出显示已启用的语法，并禁用禁
浏览 4提问于2017-06-05得票数 5
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
