如何从Sphinx的默认搜索中排除RST文件？
Sphinx是一个开源的文档生成工具，它支持使用reStructuredText（RST）格式编写文档。默认情况下，Sphinx会将所有的RST文件包括在搜索范围内，但有时我们可能希望排除某些特定的RST文件，以便搜索结果更加准确。下面是如何从Sphinx的默认搜索中排除RST文件的方法：
- 在Sphinx项目的根目录下，找到名为
conf.py的配置文件。 - 打开
conf.py文件，找到exclude_patterns配置项，该配置项用于指定要排除的文件模式。 - 在
exclude_patterns中添加要排除的RST文件的模式。可以使用通配符*来匹配多个文件，也可以使用相对路径或绝对路径来指定具体的文件。 例如，如果要排除所有以example.rst开头的文件，可以将exclude_patterns配置项修改为： - 在
exclude_patterns中添加要排除的RST文件的模式。可以使用通配符*来匹配多个文件，也可以使用相对路径或绝对路径来指定具体的文件。 例如，如果要排除所有以example.rst开头的文件，可以将exclude_patterns配置项修改为： - 如果要排除某个特定的文件夹下的所有RST文件，可以使用相对路径或绝对路径：
- 如果要排除某个特定的文件夹下的所有RST文件，可以使用相对路径或绝对路径：
- 保存
conf.py文件并重新生成文档。
通过以上步骤，你可以从Sphinx的默认搜索中排除指定的RST文件，以便更好地控制搜索结果。请注意，这里提供的是一种通用的方法，具体的配置可能因项目而异。
关于腾讯云相关产品和产品介绍链接地址，由于要求不能提及具体的云计算品牌商，我无法给出腾讯云相关产品的推荐。但你可以通过访问腾讯云官方网站，查找与云计算相关的产品和服务，以满足你的需求。
相关·内容
1回答
在使用RST编写的Sphinx项目中，有没有一种方法可以将文件排除在默认搜索功能之外？项目中的某些RST文件作为参考包含(例如许可文件)，但在搜索结果中没有用处。 是否有配置选项或指令指示Sphinx不索引特定的RST文件以包含在搜索结果中？
浏览 15提问于2020-12-02得票数 3
回答已采纳
显示我的Sphinx项目的目录结构。
cd myproject/source
tree -d
.
├── django
├── document
├── excel
├── github
├── _images
├── _templates
└── vim
每次执行命令make html时，django, document, excel, github, vim中的所有*.rst文件都将生成到*.html中。现在我只想将*.rst文件的一部分生成到*.html中，比如说，我想将所有的*.rst文件保存在github和vim un中，如何执行make html命令？
浏览 5提问于2020-08-05得票数 1
回答已采纳
我在一个编译时间很长的大型sphinx项目中工作。我想找到一种方法来编译我感兴趣的文件，而不是处理整个项目。
减少这种情况的一种方法是创建一个index_small.rst并更改makefile以使用该rst而不是标准的index.rst。
这样做的一个问题是，我会收到没有包含在toc树中的所有rst文件的警告。
浏览 0提问于2018-02-04得票数 1
我正在尝试使用sphinx-auto汇总来创建python代码的自动摘要，如下所示：
main
├───modA
| ├───__init__.py
| ├───modA.py
├───modB
| ├───__init__.py
| ├───modB.py
├───docs
| ├───build
| └───source
| ├───refs
| | |───_autosummary
| | |───index.rst
| | |───modA.rst
| | |───modB.rst
|
浏览 6提问于2020-06-06得票数 6
1回答
我的Sphinx树中有许多.rst文件，它们被故意从任何索引树中排除。我会收到这样的警告
/filename.rst:: WARNING: document isn't included in any toctree
如何抑制Sphinx中的特定警告？
浏览 1提问于2012-10-17得票数 27
回答已采纳
我需要用sphinx-build从RST构建超文本标记语言。现在我使用命令：
os.system("sphinx-build -b singlehtml -T -D html_add_permalinks=None -D extensions='sphinx.ext.autodoc' -D master_doc='index' -C /my/doc /tmp/sphinx")
但结果是，它提供了复杂的HTML和css和JS。但我只需要一个HTML页面的所有组合的RST文件。也许甚至没有目录。或者是否有可能在没有JS的情况下使用目录。我在官方文档中
浏览 2提问于2017-09-26得票数 1
我正在做一个非常简单的例子，却无法让它发挥作用。我只有一个文件，simulator.py，我向它添加了numpy样式的文档字符串。它不导入任何其他库。它有一个__init__，我可以从python解释器导入它。我的目录结构如下：
|__ modules
|__ __init__.py
|__ simulator
| |__ simulator.py
|__ docs
|__ Makefile
|__ _static
|__ conf.py
|__ index.rst
|__ modules.rst
浏览 4提问于2022-01-31得票数 0
回答已采纳
所以我把python源文件放在两个不同的目录中：-
例如：
~/work/myproject
~/.virtualenvs/myproject
如何使用sphinx-apidoc递归地查看两个目录以生成reST文件？
显然，
sphinx-apidoc -o docs/source ~/work/myproject
非常好，但是当我试图跑
sphinx-apidoc -o docs/source ~/.virtualenvs/myproject
再说一遍，sphinx告诉我“docs/source/Modes.rst已经存在，跳过了”，这当然是正确的，因为我已经运行了一次sphinx-apid
浏览 6提问于2012-10-29得票数 11
我想开始使用来记录我的项目。我告诉Sphinx在sphinx-quickstart期间使用单独的源代码和构建目录。现在我的目录布局如下：
MyProject/
myproject/
__init__.py
mymodule.py
docs/
source/
.static/
.templates/
conf.py
index.rst
build/
Makefile
哪些文件应该从Sphinx项目的VCS存
浏览 0提问于2012-03-06得票数 32
回答已采纳
我使用sphinx在readthedocs中构建了一组rst文件。文件有多个项目符号列表，但它们未正确呈现。
文本将出现，但没有项目符号或嵌套/缩进。
为了确保这不是我的文件，我直接从sphinx_rtd_theme页面()进行了复制粘贴
这就是rst应该呈现的内容(对于html文件中的每个列表项，使用::marker )
这是我使用本地的sphinx / rtd设置构建相同的rst时得到的结果
我的conf.py或其他文件中有什么需要修复的吗？
浏览 6提问于2021-05-15得票数 5
2回答
我能告诉sphinx-build不要再找index.rst了吗？
$ echo 'test' > readme.rst
$ sphinx-build -C . ./build readme.rst
这将抱怨缺少索引文件。
master file /.../index.rst not found
不过，我们可以解决这个问题。
$ ln -s readme.rst index.rst
$ sphinx-build -C . ./build readme.rst
这实际上将同时构建index.rst和readme.rst，并会抱怨readme.rst没有包含在任何toc树中。它
浏览 2提问于2020-04-22得票数 0
回答已采纳
1回答
我正在使用Sphinx特性来基于我的autodoc库的文档字符串生成文档。
交叉引用的语法可在中找到
必须在该部分之前添加标签，才能从文档的其他区域引用该部分。
我拥有的是我的一个类的.rst (ReStructeredText)文件。它使用
.. autoclass:: classname
:members:
为类生成文档。
我的问题是，如何从文档中的另一个.rst文档引用类的自动生成方法？如果我试图在方法的docstring中放置一个标签，Sphinx会报错。如果我试图在方法标题之前放置一个标签，Sphinx无法识别它。
有没有一种简单的方法可以做到这一点，或者我必须在我的类文件中
浏览 25提问于2014-03-28得票数 66
回答已采纳
点击此链接，尝试从Sphinx生成pdf：
$ sphinx-build -b pdf source build/pdf
Error: Cannot find source directory `/Users/seb/mydocs/source'.
$ make all-pdf
make: *** No rule to make target `all-pdf'. Stop.
$ make pdf
make: *** No rule to make target `pdf'. Stop.
因为在OSX中尝试过：
$ conda install -c dfr
浏览 2提问于2016-09-16得票数 33
Sphinx通常以增量方式构建文档，这意味着只有已更改的文件才会重新生成。我想知道是否有一种方法可以告诉Sphinx总是重新生成某些文件，这些文件可能没有直接更改，但受到其他文件的更改的影响。更具体的是:有没有一种方法可以告诉Sphinx总是重新生成包含某个指令的文件？我正在处理的文档依赖于经常借助指令从其他页面收集和重新格式化信息的可能性。干净(make clean && make [html])和/或完整(sphinx-build -a)构建比增量构建花费的时间要长得多。此外，手动跟踪包含指令的文件可能很复杂。这些文档是由10+作者编写的，他们在编写Sphinx文档方面的经
浏览 9提问于2017-06-26得票数 2
回答已采纳
可能有多个帖子对此扩展不起作用。我没有得到的问题是什么，因为我是新的RST。
我正试图将ref从代码块中跨到一个区段。我已经在'sphinx.ext.autosectionlabel'文件中启用了conf.py。但是我无法在生成的HTML中看到链接。
conf.py
extensions = [
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
浏览 7提问于2022-06-07得票数 0
我正在使用sphinx来记录一个python项目。我想添加一些教程作为*.ipynb。我有一个关于如何渲染jupyter笔记本的问题。这是我的代码。 我创建了一个docs文件夹，所有的sphinx命令都将在这个文件夹下运行。下面是我的对象的结构 demos/
src/
docs/
source/
config.py
demos.rst
modules.rst
src.rst
index.rst
....
build/ 下面是demos.rst的内容 Demonstration
=============
demos.tut
浏览 97提问于2020-12-16得票数 0
我有一个Python项目，使用Sphinx作为文档。我正在readthedocs.io服务上远程构建文档。
我使用了sphinx-quickstart，它生成了一个具有以下链接的index.rst文件：
Indices and tables
~~~~~~~~~~~~~~~~~~
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
当我将更改推送到readthedocs.io并构建文档时，我的构建就成功了。我通过toctree指令手动链接的文档都可以正常工作。
search链接运行良好。
但是genindex链接到一个名为“索引”的空页面。
浏览 2提问于2020-11-05得票数 0
回答已采纳
说它只重建修改过的文件。但是在这个项目中，它要重建每个模块的所有输出文件。“高亮模块代码”阶段需要特别长的时间。Python源文件一点也没有改变，sphinx-apidoc生成的sphinx-apidoc文件也没有改变--我只编辑了一些其他.rst文件。
这个项目中有超过700个模块，所以使用sphinx-build需要20分钟，即使使用-j 8也是如此。我怎样才能让它更快？
我使用的命令是：
sphinx-build -M html source build
以及source/index.rst的相关部分
.. toctree::
:maxdepth: 1
tutorial/i
浏览 0提问于2018-08-23得票数 4
回答已采纳
我正在为我的项目添加一个阅读文档页面。现在，我希望我的Read the Docs主页上的内容与我的自述文件中的内容相同。我的docs/index.rst文件如下所示：
.. include:: ../README.rst
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
这基本上是可行的，除了相对链接。例如，我的自述文件包含：
See `INSTALL.r
浏览 0提问于2017-03-05得票数 9
1回答
目前，我正在尝试使用sphinx来生成html格式的文档，但我发现一个问题是我无法使用搜索按钮来查找任何内容。我只是search一个关键字，结果不会是什么。我不知道为什么，我只是默认所有的东西。有人知道怎么修吗？
我在index.rst中写的是：
Contents:
.. toctree::
:maxdepth: 2
test.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
test.rst是：
================
eee
浏览 0提问于2012-08-09得票数 1
在用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
回答已采纳
我一直在为Python文件设置自动文档，这些文件位于目录结构的大层次结构中。我能够用我的脚本并使用autodoc模块为它们生成rst和html文件。我想知道是否可以在与Python文件相同的目录结构/目录层次结构中生成rst和html文件。
例如，我的python文件的相对路径是:python/Common.py；生成的rst文件是: python.common.element.rst；而html的路径相同。我希望它与py文件形成相同的目录结构，比如:sphinx/_build/rst/python/python/element.rst.rst&sphinx/_build/html/p
浏览 0提问于2017-09-15得票数 0
回答已采纳
我正在通过从一个SphinX源文件(即在我的index.rst文件中)获得资源来创建我的index.rst文档：
.. toctree::
:maxdepth: 2
:caption: Contents:
myMarkDownText
.
.
.
其中myMarkDownText正在引用一个myMarkDownText.md
我尝试用以下两种格式从这个源文件MarkDown文件创建一个表：
| Name | Age |
| :--- | ---: |
| John D Hunter | 40 |
在MD语法中的位置
浏览 3提问于2018-08-10得票数 1
我正在使用Sphinx的自动摘要为我的模块的每个成员自动生成单独的rst文件。文档是按预期创建的，只是生成的rst文件缺少除__init__以外的所有dunder方法。
在我的conf.py中，我有以下几行：
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
]
autosummary_generate = True
autosummary_imported_members = True
考虑下面的虚拟类，它既包含and方法，也包含常规公共方法：
class MyCla
浏览 2提问于2020-06-02得票数 2
回答已采纳
尝试使用Sphinx生成文档。 首先使用：sphinx-apidoc，然后使用：sphinx-build html 我收到了关于modules.rst文件的警告。文件存在，同时也生成了html，它看起来绝对像是一个目录。 我阅读了我能找到的关于这个主题的所有主题，都没有解决这个问题(使用.. include::指令，在index.rst文件中正确定位模块的位置...) 我不知道该怎么做才能让它工作 这是我的index.rst文件的副本，也许你会看到一些我看不到的东西。生成的rst文件位于sources文件夹中 Welcome to documentation!
===============
浏览 333提问于2020-07-10得票数 2
回答已采纳
我在GitHub上有一个README.rst，它也被合并到一个Python项目的Sphinx生成的文档中。我想在文件的顶部添加一条注释，该注释将显示在GitHub上(它只是呈现.rst)，但不会显示在由Sphinx生成的文档中。
我知道可以使用.. blah blah blah在.rst文件中包含注释，但是有没有什么方法可以包含只被Sphinx视为注释的行呢？(或者，让Sphinx忽略该行。)
浏览 0提问于2016-03-07得票数 3
我正在使用狮身人面像( Sphinx )构建一个基于Markdown文件的文档。文档非常清楚，myst解析器应该以典型的[some text](www.example.com)方式处理标记链接。
随后，我安装了myst解析器，设置了扩展extensions = ['myst_parser']并指定了source_suffix：
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': &#
浏览 3提问于2021-04-19得票数 0
回答已采纳
2回答
我正在为一家IT公司做实习，该公司需要一个用于固件文档(md文件)的文档应用程序。
请求是维护这些md文件并将它们转换为rst格式(我使用了pandoc)。所以现在我有了一个配置好的Sphinx应用程序，它只有rst文件。现在的问题是，一些rst有指向SVG映像的链接，我必须使用Sphinx的将它们转换为PDF。
我搜索了一下，并在两年前找到了这个解决方案，这基本上就是我想要的：。我试着实现它，但我不是GNU makefiles方面的专家，我不知道目前版本的Sphinx是否允许它，或者它是否有一个简单的解决方法，所以这件事没有成功。
有人有可行的解决办法吗？
浏览 4提问于2017-07-04得票数 1
回答已采纳
1回答
狮身人面像不识别子文件夹
、、、
我刚开始使用狮身人面像。只要我的文件在source顶部文件夹中，我就能够创建HTML文档。
一旦我将它们放到source directory的子文件夹中，Sphinx就不会将文档包含到构建中。Sphinx在生成测试文档后告诉我，测试文档不包括在内。因此，它会看到文件，但不包括它。
我错过什么了吗？我必须在index.rst文件或config.py中指定任何子文件夹吗？
我的index.rst文件：
Welcome to python help's documentation!
=======================================
.. toctree::
浏览 2提问于2017-08-01得票数 9
回答已采纳
我被蟒蛇sphinx困住了。我的目录树如下所示：
| - project_root
| | - importable_project
| | | - importable_module.py
| | | - another_importable_module.py
| | | - Tutorials
| | | | - tutorial1.ipynb
| | - docs
| | | - build
| | | | - sphinx_build_files_and_folders
| |
浏览 2提问于2017-10-11得票数 0
回答已采纳
当我运行sphinx-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？
下面是我想要制作的一个文档页面示例(注意TOC)：
据我所知，这是由于sphinx源代码中的apidoc.py文件(第88行)：
我可以手动编辑每个单独的.rst文件来删除这些标题，或者只是从脚本中删除这些代码行，但是接下来我必须编译Sphinx源代码。在不手动编辑Sphinx源代码的情况下，是否有一种自动完成此操作的方法？
浏览 2提问于2014-01-08得票数 18
回答已采纳
1回答
Gooday，我在自动生成python文档方面遇到了麻烦。我的项目布局如下：
project_folder
封装
module1.py
module2.py
博士
make.bat
构建
源
index.rst
package.rst
modules.rst
conf.py
在module1.py和module2.py中有一些类(带有docstring)。我在conf.py中添加了以下一行：
sys.path.insert(0, os.path.abspath('../../package'
浏览 3提问于2015-07-17得票数 4
回答已采纳
2回答
我使用上托管的sphinx生成HTML和PDF格式的文档。HTML工作得很好。PDF的构建也很成功，但在嵌套方面存在问题:我希望每个从目录链接的顶级.rst文档都作为顶级“章节”包含在PDF中。然而，它们实际上是作为子部分包括在内的，从属于头版index.rst内容.这里是我的index.rst
====
Blah
====
Welcome to the Blah project. It does various things.
Quickstart
==========
To download and install the Python package:
-------------
浏览 7提问于2020-03-26得票数 4
我正在使用Sphinx来记录一个python项目。我正在使用画布来可视化文档中的一些结果。我的文档需要支持Firefox和IE。我需要在文档中包含excanvas.js库，但前提是浏览器是IE。我如何有条件地包含这个库，这样相对路径才是正确的？
示例...
文档文件夹
/sphinx
/source
working_test_page.rst
test_block.html
/nested
non_working_test_page.rst
test_block_copy.html
/_templates
layout.html
浏览 1提问于2012-08-08得票数 7
如何让我的Sphinx RST文件包含到"contents.html“Python帮助页面的链接？
更多详细信息
我在离线环境中有一个RST帮助文档(index.rst)。我已经使用make.bat html命令下载并成功构建了Python文档。然后，我将此文档复制到C:\Temp\PyDoc。
然后，我更新了我的conf.py文件，以包含以下Intersphinx映射：
intersphinx_mapping = {'python': ('C:/Temp/PyDoc', None)}
然后，在我的index.rst文件中，我有如下内容：
Content
浏览 71提问于2018-05-26得票数 2
1回答
我正在为某个python项目编写文档。我在连接两个或多个文档时遇到了问题--我有三个Sphinx项目(文档)，我希望能够在一般文档中添加到详细文档的链接。
我有这样一个项目结构：
project/
| doc/ # this is my general doc
| | source/ # sphinx general doc .rst files are here
| | build/
| | _static/
| | _templates/
|
浏览 0提问于2012-07-27得票数 4
我的项目结构如下：
root
my_source_dir
README.md
注my_source_dir与狮身人面像预期的source-named目录不同。
我希望建立狮身人面像，以便产生的结构如下：
root
build
[HTML here]
documentation
[RST files here]
my_source_dir
Makefile
README.md
所以我在根dir中设置了狮身人面像：
sphinx-quickstart
Source root path: .
Separate source and build direct
浏览 6提问于2022-08-18得票数 -1
我继承了使用reStructuredText和Sphinx构建的用户指南，我们希望(也可以)从指南中生成一个使用rst2pdf与狮身人面像集成的PDF。我们想做的一件事是将自定义的页眉和页脚应用到文档的每一页(a‘’la“草稿-不是用于发布”或"Version x.y.z")，但是没有一种明显的方法(对我来说)。rst2pdf命令支持指定--footer="..."和--header="..."，但在--header="..."配置指令中似乎没有类似的选项可以在狮身人面像中指定。尽管RST确实支持头指令和脚指令，但Sphinx文档
浏览 13提问于2022-08-02得票数 0
回答已采纳
我在Python中使用Sphinx库时遇到了一个问题。当用户从“content：”表中选择一个选项时，所有文件内容都会显示在内容页上。
如您所见，滚动条不是在开头，而是在中间，这表明页面以前包含另一个内容。如何配置Sphinx，因此，通过从“content”中选择一个子菜单，它只显示其内容，而不是显示整个可用数据(每个选项从内容中选择一个页面)。先谢谢你。
更新1: index.rst文件的内容
TestScriptsList.rst含量
浏览 0提问于2020-06-09得票数 0
回答已采纳
0回答
我正在尝试理解如何让Sphinx工作。
我不是Python开发人员-相反，我想将reST和Sphinx用于通用文本。
所以，我安装了Python、DocUtils和Sphinx。我在C:\Test\目录中有test.rst。然后，我在这个目录中启动cmd.exe并输入：sphinx-quickstart。然后，对于默认预设，我多次按Enter键。
然后我在这个文件夹中有一些新文件，包括make.bat。然后，我运行：make.bat html。然后，创建Sphinx HTML文件。但是当我打开index.html时，我看不到原始test.rst的内容。
那么，如何让它工作呢？
(尽管标题完全相
浏览 12提问于2018-07-20得票数 1
回答已采纳
我在python项目中使用了以下conf.py。html生成的文件很好，并且提供了从代码自动生成的文档，但是pdf文件几乎是空的，并且只包含rst文件中的内容。 import os
import sys
import stanford_theme
sys.path.insert(0, os.path.abspath('..'))
extensions = ['sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.autodoc
浏览 25提问于2021-08-12得票数 0
尝试根据此处的文档添加一个简单的true/false值：
在conf.py文件中：
extensions = ['sphinx.ext.todo', 'sphinx.ext.ifconfig']
# Custom variables
def setup(app):
app.add_config_value('responsiveenabled', True, True)
在我的grids.rst文件(描述如何设置引导网格的页面)中，我有以下内容：
.. ifconfig:: responsiveenabled
Blah blah b
浏览 0提问于2012-12-28得票数 4
1回答
该计划如下。有一个名为foo的包(最初处于高度开发阶段的API )，其rst文件由sphinx-apidoc自动生成。
为了在生成这些文件之后为foo提供更好的文档，需要进行一些编辑。例如，在foo.bar.rst中，sphinx-apidoc生成的内容中添加了一些段落
当发出新的sphinx-apidoc调用时，我如何才能不泄露所有这些信息呢？当然，我希望API中的潜在更改能够得到反映，并保留这些手动信息。
浏览 0提问于2015-02-12得票数 3
回答已采纳
我有这个文件夹结构，用于在sphinx中生成文档(html)：
doc-root
- static (custom.css, custom.js)
- doc-1 (*.rst)
- doc-2 (*.rst)
- doc-3 (*.rst)
conf.py
index.rst (toctree for doc-1, doc-2 and doc-3)
我正在生成custom.js，并且只想为doc-2添加htmls作为脚本标记。
我尝试在根conf.py的设置(App)中添加app.add_javascript(' custom.js ')，但是sphinx将custom.js
浏览 0提问于2017-10-24得票数 1
apt-get install python-sphinx
apt-get install sphinxsearch
mkdir rest
cd rest/
sphinx-quickstart
我用重构后的文本创建了我的第一篇文章。
请下载它并将其解压到您的计算机上，将cd放入/rest/build/html，然后用您的chrome打开index.rst。
我发现在重构文本搜索函数中：
1.不能搜索中文字符
2.无法搜索短词
请参阅附件1，这是我要搜索的目标文章
你可以在文本中看到is和标准。
请参阅附件2，无法搜索正文中的汉字标准。
请参阅附
浏览 2提问于2013-05-25得票数 5
回答已采纳
我有以下两门课：
class Test1():
"""Test1()"""
def fn_test1():
"""fn_test1 """
print "Hello1"
。
class Test2():
"""Test2()"""
def fn_test2():
"""fn_test2 """
浏览 1提问于2014-09-05得票数 3
我正试图用狮身人面像来构建文档，却找不出如何使用: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
回答已采纳
3回答
我刚刚开始使用Sphinx工具为我的代码生成文档。但我有点困惑，因为它并不像我想象的那么容易。我使用以下命令创建Sphinx文档：
sphinx-quickstart
然后我在“*.rst”文件夹中创建我的源文件。似乎我需要为每个要为其创建文档的模块创建一个*.rst文件。对于test.py，我创建了test.rst。在test.rst内部，我有：
.. automodule:: test
:members:
:show-inheritance:
然后在test.py中，我有：
"""
.. module:: test
:platform: Uni
浏览 0提问于2011-05-24得票数 15
回答已采纳
我正在使用rST/Sphinx来记录我的Python，但是在构建它时会抛出警告，比如
...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast".
我的Python源文件的文档如下：
#!/usr/bin/env python
'''
.. module:: toast
:synopsis: Processes the blobs produced by :mod:`bread`.
'''
# my inline-rST documented code...
r
浏览 2提问于2013-05-10得票数 5
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
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
