如何将JSON/XML/YAML数据读入Sphinx RST文件，以编程方式生成文档页面？
将JSON/XML/YAML数据读入Sphinx RST文件并以编程方式生成文档页面，可以通过以下步骤实现：
- 首先，你需要使用适合你喜欢的编程语言来处理JSON/XML/YAML数据。你可以使用Python，JavaScript，Java或其他支持这些数据格式的语言。
- 在读取JSON/XML/YAML数据之前，你需要了解数据的结构和字段。这将帮助你在生成文档页面时能够正确地引用和显示数据。
- 针对不同的数据格式，你可以使用相应的解析库来读取数据。例如，对于JSON，你可以使用Python中的
json库，对于XML，你可以使用Python中的xml.etree.ElementTree库，对于YAML，你可以使用Python中的pyyaml库。 - 读取数据后，你需要将数据转换成适合Sphinx RST文件的格式。这可能涉及到将数据分割成段落、列表、表格等格式。
- 接下来，你需要编写代码将转换后的数据写入Sphinx RST文件。你可以使用文件操作函数将数据写入文件，或者使用Sphinx提供的API来生成RST文件。
- 在Sphinx RST文件中，你可以使用适当的标记语言来呈现数据。例如，对于段落，你可以使用适当的RST标记来指示段落的标题、格式和样式。
- 最后，你可以使用Sphinx的构建命令将RST文件编译为HTML或其他格式的文档页面。Sphinx提供了一些命令和配置选项，可以根据需要自定义生成的文档的外观和布局。
总结起来，将JSON/XML/YAML数据读入Sphinx RST文件并以编程方式生成文档页面的过程包括数据读取、数据转换和写入RST文件，使用Sphinx的标记语言呈现数据，最后使用Sphinx构建命令生成文档页面。
在腾讯云中，你可以使用腾讯云文档服务（https://cloud.tencent.com/document/product/213）来存储和管理你的文档数据，腾讯云SLS日志服务（https://cloud.tencent.com/product/sls）来记录和分析文档生成的日志信息，并且可以使用腾讯云API网关（https://cloud.tencent.com/product/apigateway）来构建和管理文档生成的API接口。这些产品可以帮助你在云计算环境中更好地管理和部署你的文档生成工作流程。
相关·内容
我目前正在使用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
回答已采纳
点击此链接，尝试从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
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
回答已采纳
假设我有一个动物园动物的JSON/YAML/XML等，我想为动物园中的所有动物制作一些文档。所以我有一个像这样的JSON： {
"zooName": "C town's Zoo",
"animals": [
"tiger": {
"species":"some_species_name_here",
"weight": 120
},
"bear":{
"species":&#
浏览 25提问于2021-10-19得票数 1
我正在编写RST格式的文档，并使用Sphinx生成HTML。
我希望能够在RST文件中编写段落，并在同一文件夹中的不同RST文件中重用相同的段落。我想要重用，这样如果我在原始段落中做了更改，它应该在我使用Sphinx生成HTML时引用的所有其他文件中自动更改。
有没有什么RST语法可以实现这一点？任何帮助都是非常感谢的。
浏览 3提问于2017-01-30得票数 2
1回答
我希望将Linux内核rst文件转换为html文档。请提供明确的步骤，以安装所需的软件包和命令，以生成rst文件到html。
我用以下命令安装了狮身人面像
sudo apt-get install sphinxsearch
运行“”时面临错误
The Sphinx 'sphinx_rtd_theme' HTML theme was not found
如果可能的话，你能帮我安装正确的软件包吗？看起来很棘手，我已经试够了。
浏览 4提问于2018-05-03得票数 0
1回答
我想从嵌套文件夹结构中的脚本中生成sphinx autodoc文档：
└── programs
└── general_name
└── another_folder
├── script1.py
└── script2.py
由于某些原因，script1.py和script2.py没有在autodocs中显示，我只看到脚本名：
programs.general_name.another_folder package
¶Submodules
programs.general_name.another_folder.sc
浏览 1提问于2018-01-21得票数 4
在用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
回答已采纳
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源代码，它使用读文档主题。源树如下所示：
source
├── conf.py
├── index.rst
├── models
│ ├── 1lin
│ │ ├── 1lin_Amplero.rst
│ │ ├── 1lin_Blodgett.rst
│ │ ├── 1lin_Bugac.rst
│ │ ├── ..
│ │ ├── figures
│ │ │ ├── 1lin_all_PLUMBER_plot_all_metrics.png
│ │ │ ├── 1lin_all_PLUM
浏览 0提问于2016-10-13得票数 8
回答已采纳
我的Python Sphinx restructuredtext项目包含空的第一级部分。如何将用户重定向到HTML输出的第一个子部分，而不求助于原始Javascript？
嗨,
index.rst格式如下：
Title
=====
.. toctree::
:hidden:
foo.rst
bar.rst
为了避免显示空白的index.html页面，我通过以下技巧自动显示第一个子部分，即foo.html：
Title
=====
.. raw:: html
<script type="text/javascript">
wind
浏览 0提问于2019-07-11得票数 0
我有一个git存储库，其中包含多个跟在名称空间后面的包(即。
我正在尝试使用Sphinx创建一个ReadTheDocs文档。
git存储库如下所示：
为了在我的本地机器上测试它，我使用了Sphinx的docker镜像sphinxdoc/sphinx。
我尝试使用不同的方法为我的所有包生成文档，但每种方法都有不同的问题。
sphinx apidoc
docker run -it -v pwd:/repo --rm rtd bash -c 'make clean && rm -rf /repo/docs/_source/* && sphinx-apidoc
浏览 8提问于2021-02-05得票数 1
我目前正在将所有现有的(不完整的)文档迁移到。
问题是文档使用 (模块是用C语言编写的，但这可能无关紧要)，并且必须将类文档转换为可用于Sphinx的格式。
虽然有，但它会自动将当前文档字符串放到文档中。我想基于当前的文档字符串在()中生成一个源文件，然后我可以手动编辑和改进它。
如何将文档字符串转换为Sphinx的RST？
浏览 1提问于2010-04-19得票数 7
回答已采纳
1回答
因此，在通过.rst生成sphinx-apidoc文件时，我一直试图让Sphinx为所有子模块/类生成继承图，类似于这个。但我还没有在狮身人面像中找到任何内置的功能来做到这一点。
我找到的最接近的解决方案是在代码中向每个类docstring中添加一个带有类名的继承关系图，但这不太方便。
因此，问题是如何将继承图添加到所有模块.rst文件中？
浏览 2提问于2019-12-12得票数 1
我有一个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
回答已采纳
我正在尝试在我已经完成的烧瓶上实现狮身人面像文档。当我尝试使用以下命令运行Sphinx时：
sphinx-apidoc -F -A "MonitoringApplication" -V "0.1" -o docs App
它为我的python脚本创建rst文件，但退出时会出现以下错误: in：Sphinx\quickstart.py, line 1328, in generate conf_text = QUICKSTART_CONF % d KeyError: u'language
谷歌这个错误并没有对我有多大的好处，所以我来到这里！额外信息：
Sp
浏览 0提问于2014-11-26得票数 2
回答已采纳
当我运行sphinx-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？
下面是我想要制作的一个文档页面示例(注意TOC)：
据我所知，这是由于sphinx源代码中的apidoc.py文件(第88行)：
我可以手动编辑每个单独的.rst文件来删除这些标题，或者只是从脚本中删除这些代码行，但是接下来我必须编译Sphinx源代码。在不手动编辑Sphinx源代码的情况下，是否有一种自动完成此操作的方法？
浏览 2提问于2014-01-08得票数 18
回答已采纳
我一直在为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为Flask应用程序生成文档时遇到了问题。不深入该应用程序的具体细节，其基本结构如下所示。
__all__ = ['APP']
<python 2 imports>
<flask imports>
<custom imports>
APP = None # module-level variable to store the Flask app
<other module level variables>
# App initialisation
def init():
global APP
浏览 2提问于2017-06-22得票数 3
我在github有一个。包没有外部依赖项，所有源都包含在一个__init__.py文件中。在./docs文件夹中，我只有两个rst文件:一个带有一些介绍的index.rst和一个nix_shell_utils.rst文件，其中包成员自动从它们的文档字符串中描述：
nix_shell_utils.rst文件
nix_shell_utils package
浏览 21提问于2022-11-06得票数 1
回答已采纳
1回答
我有一个机器人文件(calc_check.robot)，其中每个测试用例都有单独的文档。
*** Settings ***
Documentation
... The test cases are designed to test the calculator .
Library ../../Library/AddNumbers
*** Test Cases ***
Calc_check_test Testcase01_a
[Documentation]
... Verify that two numbers are added or not
[
浏览 0提问于2018-04-13得票数 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
回答已采纳
1回答
我正在尝试用Python记录一个包。目前，我有以下目录结构：
.
└── project
├── _build
│ ├── doctrees
│ └── html
│ ├── _sources
│ └── _static
├── conf.py
├── index.rst
├── __init__.py
├── make.bat
├── Makefile
├── mod1
│ ├── foo.py
│ └── __init__.py
├── m
浏览 3提问于2014-08-28得票数 12
回答已采纳
使用sphinx，我如何让我的git仓库根目录中的README.rst包含在我的sphinx文档中的index.rst中？我正在使用apidoc和autodoc。一个很好的例子是APScheduler，如果你看一下，你会注意到他们的docs/index.rst和他们的README.rst几乎一样
浏览 1提问于2015-01-28得票数 2
我被蟒蛇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
回答已采纳
1回答
我的Sphinx树中有许多.rst文件，它们被故意从任何索引树中排除。我会收到这样的警告
/filename.rst:: WARNING: document isn't included in any toctree
如何抑制Sphinx中的特定警告？
浏览 1提问于2012-10-17得票数 27
回答已采纳
1回答
我试图获得Python和Sphinx文档主页上的效果。我是说目录结构。是否有任何关键字为树获得类似的效果，或我必须手动这样做？我试图在文档中找到一些东西，但没有取得任何成功，可悲的是，Sphinx文档的主页没有提供rst文件的来源。
有什么想法吗？
这是
我需要部分文档的格式效果与成员，如第一步，搜索页面，内容和一般索引。
浏览 4提问于2013-11-28得票数 2
回答已采纳
我正在尝试使用Sphinx为Python项目生成文档。为了确保我可以让它真正工作，我做了一个测试项目来尝试它：。
我在这个存储库的根目录下运行了sphinx-quickstart。在以下问题中，我指定'doc‘作为文档根目录，将项目命名为'sphinxtest'，输入'Thomas Arildsen’作为作者，对'autodoc‘选项回答'y’，并为其他所有内容选择默认设置。
我预计'autodoc‘选项会导致在'doc’文件夹中生成一个'amodule.rst‘文件。但是，这不会生成。我对此感到困惑。我认为这就是'
浏览 0提问于2017-05-19得票数 0
3回答
我有一个全新的CentOS 6框，想安装狮身人面像，以便编译由readthedocs.org生成的文档，即rst文件。
在以前的一个ubuntu盒中，我正在运行
make html
而这将调用
sphinx-build
命令并编译文档。
我下载了斯芬克斯的最新版本，并将其安装如下：
sudo wget http://sphinxsearch.com/files/sphinx-2.1.9-1.rhel6.x86_64.rpm
sudo localinstall sphinx-2.1.9-1.rhel6.x86_64.rpm
一切似乎都很好，但sphinx-build却无处可寻。
任何指点都是非
浏览 4提问于2014-07-05得票数 2
回答已采纳
如何让我的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
我正在尝试使用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回答
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
回答已采纳
我使用来记录Python模块。我有一个主doc目录，在该目录中，我将单独的*.rst文件(针对每个模块组件)放入index.rst主文件中。这很好(请查看，看看我是如何做到的)。
我的问题是当我需要为给定的模块组件(而不是整个模块)创建一个独立的PDF时。
假设您对整个模块(库)具有与相同的结构，然后您将创建一个独立的PDF，用于crypto组件的文档。你怎么做？
创建一个不同的索引(index_2.rst)，并且只包含该文件(crypto.rst)
注释原始index.rst中的其他文件
使用独立的Sphinx文档在crypto中创建一个全新的文档目录
这些方法似乎都不简
浏览 3提问于2010-08-17得票数 2
Sphinx引用的RST文档是“权威的reStructuredText用户文档”(请参阅)，其中显示了几种用于设置编号列表格式的样式，其中包括括号样式(请参阅)：
(1) foo
(2) bla
但是，Sphinx会从以下RST源中生成带有点的样式：
1. foo
2. bla
Sphinx文档只显示了虚线样式(请参阅)。
我的问题是:有没有办法让Sphinx为数字创建带括号的样式？
浏览 15提问于2018-09-04得票数 3
有没有办法用Sphinx在rst文件中渲染MathML？
我在conf.py中启用了mathjax扩展。它使用like与latex配合得很好
但是，如果我用数学ML替换它，它确实会呈现它，但会显示所有的xml代码。例如,
产生
在Sphinx中，数学是由mathjax扩展呈现的。在上，mathjax声称他们支持MathML。
浏览 1提问于2018-05-26得票数 3
我在GitHub上有一个README.rst，它也被合并到一个Python项目的Sphinx生成的文档中。我想在文件的顶部添加一条注释，该注释将显示在GitHub上(它只是呈现.rst)，但不会显示在由Sphinx生成的文档中。
我知道可以使用.. blah blah blah在.rst文件中包含注释，但是有没有什么方法可以包含只被Sphinx视为注释的行呢？(或者，让Sphinx忽略该行。)
浏览 0提问于2016-03-07得票数 3
我有一个很好的关于项目的Sphinx文档，我想扩展它来生成文档，如规范和其他文档。我希望有生成spec-for-foo.pdf的spec-for-foo.rst
浏览 0提问于2013-04-08得票数 3
回答已采纳
4回答
我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我在指示Sphinx递归扫描我的文件时遇到了困难。
我有一个Python代码库，它的文件夹结构如下：
<workspace>
└── src
└── mypackage
├── __init__.py
│
├── subpackageA
│ ├── __init__.py
│ ├── submoduleA1
│ └── submoduleA2
│
└── subp
浏览 5提问于2011-01-06得票数 54
回答已采纳
我一直在构建一个具有许多不同功能的Python模块。
我使用狮身人面像和readthedocs来提供文档。我已经取得了不错的进步，但目前我有一个，它为我的所有函数提供文档(按字母顺序排列)。
我看过其他项目，每个函数都有一个单独的页面。在查看它们的源代码时，我发现已经为每个源创建了一个单独的.rst文件。我假设这是自动完成的，而在生成autodoc摘要时似乎是在描述其中的一些内容，但我无法理解。
有一个选项(-e)为每个模块创建一个页面，但我希望每个函数都有一个页面。
如何使用Sphinx为每个函数自动生成一个单独的页面？
附加信息
为了为下面的一个答案添加信息，我将以下内容放入位于子目录E
浏览 8提问于2017-04-11得票数 9
回答已采纳
我使用的是Sphinx版本的1.4.5。
我的项目结构如下：
+ src > main.py + docs (generated with sphinx-quickstart)
即使在docs/conf.py中将路径添加到src文件夹之后也是如此
sys.path.insert(0, os.path.abspath('../src'))
并使用以下命令为src/main.py (即docs/src.rst和docs/modules.rst)生成rst文件：
$ sphinx-apidoc -fo docs src
当我尝试使用以下命令构建html网页时：
$ make c
浏览 5提问于2016-08-16得票数 2
回答已采纳
3回答
使用Sphinx 0.6.5创建。
我知道Python的文档使用reStructuredText，但它有不同的部分，如http://docs.python.org/whatsnew/2.6.html和http://docs.python.org/tutorial/index.html。
如何在reStructuredText中做到这一点？您是否在一堆目录中运行rst2html，保持其结构？
我知道它使用狮身人面像(不是像所说的那样直接使用)，但是您应该如何使用存储库中的源代码文件来组织rst结构，以便您有一个完整的自动化文档网站？
浏览 9提问于2010-05-18得票数 10
回答已采纳
我想通过reST生成文档，但不想手动编写reST源代码，但让python脚本来做这件事，然后用sphinx生成其他格式(HTML )。
假设我有一个二进制格式的电话簿。现在我使用一个python脚本来解析它，并生成一个包含所有名称和数字的文档：
phone_book = PhonebookParser("somefile.bin")
restdoc = restProducer.NewDocument()
for entry in phone_book:
restdoc.add_section( title = entry.name, body = ent
浏览 11提问于2011-03-13得票数 7
回答已采纳
1回答
我正在尝试使用Sphinx为我的项目生成文档，但输出文档不包含我的任何类。我做错了什么？下面是我用来生成文档的命令：
> ls
Aplikacja.py* Baza.py doc/ EkranLogowania.py EkranRejestracji.py InterfejsWWW.py RequestHandler.py _static/ util.py
BazaLoginow.py BladWalidiacji.py EkranBledu.py EkranMenuGlownego.p
浏览 0提问于2012-11-12得票数 14
回答已采纳
我想开始使用来记录我的项目。我告诉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
回答已采纳
2回答
我使用sphynx从静态.rst文件生成文档(没有文档字符串提取)。
我的存储库中有两个文件：
index.rst
.. toctree::
intro
和intro.rst
Will be skipped
===============
Where is my parent section?
---------------------------
Second section
==============
以下是通过运行sphinx-build -b latex . _build; cd _build; pdflatex *获得的pdf屏幕截图：
拉伤还是什么？
浏览 0提问于2015-01-15得票数 5
回答已采纳
我有下面的包结构作为一个最小的例子(为了方便，所有都上传了)：
.
├── sphinx
│ ├── build
│ ├── Makefile
│ └── source
│ ├── conf.py
│ ├── index.rst
│ └── train.rst
└── train
├── __init__.py
└── train.py
在编写package时，必须在任何包的__all__中指定__init__.py常量，以便狮身人面像能够将引用(如train.DatasetMeta )映射到train.train.Dataset
浏览 0提问于2018-08-16得票数 16
2回答
我在本地使用带有.md文件的sphinx。当我以下面的格式添加一个表时：
something |其他|更多
一|二|三
文本正被解析为一个段落。我已经尝试过rst文件，它以这种格式工作：
===== ===== ====
oneee ttttt ffff
===== ===== ====
sdddd dfvgd sdfv
dfgvv dffff ffff
===== ===== ====
当我使用rst文件时，我收到关于错误结构的表的错误消息，而在md文件中，它变得静默。
有什么想法吗？
浏览 3提问于2017-06-09得票数 10
我正在尝试开始使用Sphinx，但似乎遇到了一些棘手的问题。
命令：docs/sphinx-quickstart
我回答了所有的问题，一切都很好。
命令：docs/ls
看起来一切正常。结果：build Makefile source
命令：sphinx-build -d build/doctrees source build/html
它似乎起作用了。我能够打开index.html文件并看到我想要的“外壳”。
当我尝试将我的实际源代码放在source文件夹中时，我遇到了问题。
命令：sphinx-build -d build/doctrees ../ys_utils build/html
浏览 2提问于2012-04-26得票数 120
我需要用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
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
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
