Sphinx从过时的源代码生成HTML输出
Sphinx是一个开源的文档生成工具，它可以从源代码中自动生成高质量的文档，并支持将文档输出为HTML、PDF、EPUB等多种格式。下面是对这个问答内容的完善和全面的答案：
Sphinx是一个基于Python的文档生成工具，它的主要特点是可以从源代码中自动提取注释和文档字符串，并根据一定的规则生成结构化的文档。Sphinx支持多种文档格式，包括HTML、PDF、EPUB等，可以根据需要选择合适的输出格式。
Sphinx的主要优势包括：
- 自动化文档生成：Sphinx可以自动从源代码中提取注释和文档字符串，并生成结构化的文档，大大减少了手动编写文档的工作量。
- 多种输出格式：Sphinx支持多种文档输出格式，包括HTML、PDF、EPUB等，可以根据需要选择合适的输出格式。
- 丰富的扩展功能：Sphinx提供了丰富的扩展功能，可以通过插件来扩展其功能，例如支持自定义主题、添加代码高亮、生成索引等。
- 与代码集成：Sphinx可以与代码版本控制系统集成，可以直接从代码仓库中生成文档，并与代码的变更进行同步。
Sphinx的应用场景包括但不限于：
- 开源项目文档：Sphinx适用于开源项目的文档生成，可以从源代码中提取注释和文档字符串，生成项目的API文档、用户手册等。
- 内部文档：Sphinx也适用于内部文档的生成，可以从代码中提取注释和文档字符串，生成团队的技术文档、项目文档等。
- 在线文档：Sphinx生成的文档可以部署到Web服务器上，提供在线访问，方便用户查阅和搜索。
腾讯云提供了一款名为腾讯云开发者文档的产品，可以帮助开发者快速生成和发布文档。该产品支持与Sphinx集成，可以将Sphinx生成的文档直接发布到腾讯云开发者文档平台上。您可以通过以下链接了解更多关于腾讯云开发者文档的信息：腾讯云开发者文档
需要注意的是，本回答中没有提及亚马逊AWS、Azure、阿里云、华为云、天翼云、GoDaddy、Namecheap、Google等流行的云计算品牌商，因为根据问题要求，不得提及这些品牌商。
相关·内容
我正在做几个使用Java编写的库的Jython项目。多亏了autodoc扩展，我想用Sphinx创建一些好的文档。然而，当我尝试创建html时，我得到了错误，因为autodoc找不到用Java编写的库：
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.0.5
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environmen
浏览 2提问于2011-02-08得票数 7
回答已采纳
我在使用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
我在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
1回答
我开始使用cassandra，我想用sphinx来索引我的数据库。我写了一个ruby脚本，它被用作xml管道，并且我配置了sphinx来使用它。
source xmlsrc
{
type = xmlpipe2
xmlpipe_command = /usr/local/bin/ruby /home/httpd/html/app/script/sphinxpipe.rb
}
当我从控制台运行脚本时，输出看起来很好，但当我运行indexer sphinx时，返回错误
浏览 0提问于2010-06-17得票数 0
回答已采纳
我有一个主要是Python的大型项目，我正在尝试记录该项目。这个项目的一部分依赖于C++源代码，这些源代码可以通过Cython访问。 当像正常一样运行代码时，它运行得很好，但在尝试使用Sphinx进行自动文档记录时，我遇到了问题。我认为this guy的想法是对的，但我不能让它起作用。 我的Makefile看起来像这样 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for th
浏览 34提问于2020-10-11得票数 0
回答已采纳
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
回答已采纳
假设我正在为我的RestructuredText/Sphinx编写一个自定义编辑器，带有"live“html输出预览。输出是使用Sphinx构建的。 源文件是纯RestructuredText。那里没有代码。 一个理想的特性是，右键单击预览的某个部分，将在源文件的正确行打开编辑器。 为了实现这一点，一种方式是将行号放入html文件的每个标签中，例如使用类(例如，class = "... lineno-124")。或者使用html注释。 请注意，我不想在源文件中添加更多内容，只希望在输出中的任何地方都包含行号。 大致的行数就足够了。 有人知道如何在Sphinx中做到这一
浏览 30提问于2019-09-18得票数 1
我对doxygen和sphinx的用法还不熟悉。我有一个要求创建的文件，这是在C语言编程。这个想法是从doxygen为每个文件生成xml文件，然后使用breathe作为连接到sphinx的桥梁来创建html页面。我成功地生成了xml文件，也能够获得html页面。但是，我看到每个html文件包含所有文件内容，而不是每个文件/目录包含每个html。
ie. dir1 => file1.h and file1.c
dir2 => file2.h and file2.c
输出：
file1.html => file1.xml & file2.xml
file2.htm
浏览 0提问于2014-07-16得票数 7
我目前正在使用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-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？
下面是我想要制作的一个文档页面示例(注意TOC)：
据我所知，这是由于sphinx源代码中的apidoc.py文件(第88行)：
我可以手动编辑每个单独的.rst文件来删除这些标题，或者只是从脚本中删除这些代码行，但是接下来我必须编译Sphinx源代码。在不手动编辑Sphinx源代码的情况下，是否有一种自动完成此操作的方法？
浏览 2提问于2014-01-08得票数 18
回答已采纳
我最新的狮身人面像文档在试图用readthedocs构建它时失败了。这与我试图加入一些来自的徽章有很大的关系。这些徽章是.svg图形文件。
我可能需要对我的conf.py文件做一些调整吗？
在我的本地机器上，我能够生成Sphinx文档，并且所有HTML文件看起来都不错。
以下是我的conf.py文件的摘录：
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They ca
浏览 5提问于2022-06-03得票数 0
回答已采纳
我对狮身人面像很陌生。我在Sphinx官方文档站点上阅读了一些有关它的内容，并按照以下步骤在我的Debian Wheezy服务器上安装和配置它：
首先，我已经在上安装了狮身人面像源。
安装狮身人面像
我已经执行了配置根目录和conf.py的脚本conf.py。
狮身人面像-快速启动
我已经执行了make html命令，用于在我的目录路径中构建HTML。
使html
我已经安装了Sphinx自动构建，用于处理文档的每一次更改/更新，就像@ 编写的那样。
pip安装狮身人面像-自动构建
sphinx-自动构建源代码构建/html
我已经修复了
我的第
浏览 2提问于2017-03-26得票数 4
回答已采纳
到表单中的git存储库的外部超链接
.. _Git repo: git://github.com/migueldvb/repo.git
在HTML文档中正确显示，但它们没有显示在PDF文件中。运行python setup.py sphinx_build -b latex以生成LaTeX文件时会出现警告：
unusable reference target found git://github.com/...
如何将指向git存储库的超链接包含在Sphinx生成的PDF文档中？
浏览 2提问于2013-09-01得票数 4
回答已采纳
我正在试着使用/理解斯芬克斯的需求。一旦我运行以下命令，它就会生成needs.json
sphinx-构建-b需要源构建
但是如何从needs.json生成html输出呢？我不希望有任何自定义布局--默认布局或预定义布局(如“完成”)将完成
谢谢你的回答
浏览 2提问于2021-04-25得票数 0
回答已采纳
1回答
我正在自动生成由Sphinx呈现为几种格式的reStructuredText文件，包括HTML。reStructuredText文件有时包含HTML特殊字符，例如HTML无法转义的<，从而导致无效的HTML。这使我无法自动化文档生成过程，迫使我手动修复输出文件。这个问题的一个具体例子是：
<div class="line">
<code class="docutils literal notranslate">
<span class="pre">public</span&g
浏览 1提问于2019-06-06得票数 1
回答已采纳
我正试图建立一个程序，将使用基本的语音识别。在试图查找voice.config.xml文件中的“识别器”组件时，我遇到了一个问题。我对使用Sphinx4还比较陌生，所以这可能是一个非常简单的错误。我已经花了几个小时来寻找它，所以如果能给出一个很好的解释和详细的答复，我们将不胜感激。
这是我将用来翻译输入的方法。
public static void translate() {
URL url = S2T.class.getResource("voice.config.xml");
ConfigurationManager cm = new Confi
浏览 2提问于2014-11-09得票数 0
2回答
我试图使用sphinx (与autodoc和numpydoc一起)来记录我的模块，但是在基本设置之后，运行make html只生成基本的html，而文档字符串中没有任何内容。我正在运行Python3.3，项目结构的大纲如下：
Kineticlib
|--docs
| |--build
| |--source
| | |--conf.py
|--src
| |--kineticmulti
| | |--__init__.py
| | |--file1.py
| | |--file2.py
|--setup.py
__init__.py为空，在conf.py中，在docs/s
浏览 3提问于2014-07-23得票数 6
回答已采纳
我需要用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
在我错误地运行之前，如果向Sphinx添加一个新的输出格式，那么可能需要向所有现有的Sphinx扩展添加特例代码吗？
例如，我看到“todo”扩展似乎尝试并使用警告，但必须有特例乳液代码--我是否必须对其他人可能使用的每个扩展做类似的操作，除非我可以做一些类似的操作来重用现有的格式化功能？
浏览 1提问于2018-04-23得票数 1
回答已采纳
1回答
我正在尝试用sphinx为我的python项目构建文档，但我还不知道怎么做。
首先，我的项目在这个文件夹中：
(scientific_python_2_7) lpuggini@lpuggini-T3420:~/docs$ ls ~/mlp/trunk/
applearning clean_only.sh mlearncnepack SecurityReport
build_only_docker.sh collection mlearn.egg-info setup.py
build_only.sh
浏览 0提问于2018-04-05得票数 0
如何在Sphinx源目录之外自动生成的Sphinx .rst文件中包含图像？
我使用CMake构建了一个狮身人面像项目。Sphinx源文件之一包括由CMake项目中的一个单独目标生成的PDF映像。据我所知，不应该在CMake源树中生成来自CMake构建过程的输出。(我认为这是有道理的，因为不同的CMake构建配置会产生不同的输出)。因此，Sphinx构建的输入不能在Sphinx源树中，而且在编写Sphinx代码时，将包含在Sphinx文档中的图像的相对路径是未知的。
我怎么才能解决这个问题？
浏览 2提问于2021-12-15得票数 1
我们有一个Sphinx配置，它将为我们的整个代码库生成大量HTML文档。有时，我正在处理一个文件，我只想查看该文件的HTML输出，以确保在不运行整个套件的情况下语法正确。
我寻找了一个在终端上运行的最简单的命令来对这个文件运行sphinx，我确信信息就在那里，但我没有看到它。
浏览 2提问于2012-05-22得票数 16
2回答
我正在考虑通过将渲染转移到客户端来提高网站性能。当前堆栈是：(router, sphinx, db) + HTML。我正在考虑将其更改为：(router, sphinx, db) + JSON。
所有的客户端都运行i7处理器，它们并不太关心客户端的渲染性能。我们还有客户端应用程序，它可以连接到resful JSON API (这不是关于客户端与服务器端渲染的讨论)。
1)在服务器上渲染需要大约20%的时间( 80%用于路由、sphinx、db)。我听说输出JSON花费的时间大约是输出HTML的一半，所以我认为会有10%的改进，而这10%可以用于数据处理。我说的对吗？
2)我认为，一台服务器的1
浏览 1提问于2012-12-17得票数 0
2回答
在构建html文档时，如何强制sphinx在不存在的链接上报告或创建错误？
具体地说，我的Python项目中有一些属性和方法已被删除或重命名，很难找到sphinx生成的html输出的所有无效链接。
我觉得我正盯着这里的答案：，正如开头一段所描述的那样。
很明显我不明白什么。
浏览 0提问于2013-01-24得票数 15
我正在开发一个非常大的代码库，它使用sphinx-apidoc从Python源代码中的文档字符串自动生成HTML文档。文档字符串使用以下格式：
:param message:要显示的消息
:type message: string
：return:带格式的字符串
:rtype:字符串
将Sphinx HTML文档替换为以不同方式组织/表示的内容已经成为一种需求--但我们仍然希望从源代码中的文档字符串自动生成。有没有办法用Sphinx生成中间格式(比如xml)的文档？我还没有找到这样做的方法。有人知道我会做什么吗？
浏览 1提问于2012-10-27得票数 4
回答已采纳
Sphinx支持以下几种输出格式：
多个text文件(使用.pdf或dirhtml)Latex创建.pdf或.ps HTML时非常有用
如何获取Microsoft Word文件中的输出？
使用另一个文档生成器，我设法生成了一个单独的html输出文件，然后使用Word应用程序将其转换为Microsoft Word格式。
不幸的是，我不知道如何生成Word或HTML单页格式。
浏览 201提问于2009-05-13得票数 25
所以我跟踪了这个链接https://www.learn2crack.com/2013/07/learn-to-hack-wifi-password-with-ubuntu.html
我被第七步困住了。我正在粘贴第6步的输出，以防出错。
root@Sphinx-PC:~/reaver-1.4/src# ./configure
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking
浏览 0提问于2018-07-29得票数 0
回答已采纳
如何在狮身人面像中禁用语法突出显示？
我尝试过设置和。
也尝试过。
我尝试删除html和make clean。但是语法高亮显示是存在的。(使用Alabaster主题)
conf.py配置了以下扩展：
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.ifconfig',
'sphinx.ext.v
浏览 4提问于2017-05-03得票数 1
回答已采纳
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来格式化Python文档，使用cement来配置CLI。不幸的是，Sphinx会从cement配置中生成大量无意义的输出。
我找不到任何Sphinx指令或命令行选项来忽略不应该格式化的水泥配置。我们使用的是Sphinx 2.2.0和带有选项-f -P -o的sphinx-apidoc。
例如，Sphinx对此Python进行格式化
class BaseController(cement.Controller):
""" Base controller for command line application """
浏览 1提问于2019-09-10得票数 0
public static void main(String[] args) { try {
URL url;
if (args.length > 0) {
url = new File(args[0]).toURI().toURL();
} else {
url = HelloWorld.class.getResource("helloworld.config.xml");
}
Sys
浏览 1提问于2013-03-21得票数 0
回答已采纳
我下载了带有.tar.gz扩展的源代码。我把它提取出来
tar -xzf pgamdin4-5-6.tar.gz
但是，在pgadmin4-5-6目录中没有configure文件。我认为我们运行./configure是为了创建一个Makefile，因此Makefile已经存在。这就是我运行ls时得到的
DEPENDENCIES
Dockerfile
docs
LICENSE
Make.bat
Makefile
pkg
README.md
requirements.txt
runtime
tools
web
我试过了
$ make
这给我带来了错误：
file "build_co
浏览 0提问于2021-07-13得票数 -1
在尝试修复Sphinx构建错误时，在捕获异常时将IDE放入断点将非常有用。然而，sphinx-build似乎正在捕获异常，然后没有完全将它们提升到集成开发环境中。有没有办法告诉sphinx-build完全抛出异常？
更具体地说，在我的集成开发环境(PyCharm)中，我有一个运行sphinx-build的运行配置。如果我在Sphinx conf.py中添加一个断点，调试器将正确地放入该断点。启用IDE的异常捕获后，我希望IDE在异常时进入断点(就像它对其他Python运行所做的那样)。但是，看起来sphinx-build正在捕获异常，打印自己的输出错误消息，而不是进一步引发异常。它这样做似乎是
浏览 4提问于2019-10-15得票数 1
我使用Sphinx生成HTML文档。一切都很好，但是由于某些原因，生成的HTML文件中的源代码和注释确实过时了。我甚至不明白这怎么可能。我已经多次删除所有文件，并再次生成它，但仍然存在相同的问题。
浏览 34提问于2021-01-28得票数 1
我使用的是狮身人面像扩展()，它动态地生成一些ReST标记。狮身人面像使用这个ReST生成html文档。
我想检查并运行对生成的ReST标记的doctest。通常我用
sphinx-build -E -b html docs dist/docs
若要生成html输出，则不存在与rst输出相同的html“生成器”。
如何检查生成的ReST标记？
浏览 0提问于2019-07-21得票数 1
回答已采纳
我使用Sphinx生成一些Python文档。如果我转到build/html目录并直接打开index.html，我会得到Sphinx格式。 如果我尝试使用以下代码提供相同的页面Flask，我会得到该页面，但所有的Sphinx格式都消失了： from flask import send_from_directory
@app.route('/help')
def help():
return send_from_directory('/sphinx/build/html', 'index.html') 我在调试模式下使用app.run直接
浏览 32提问于2019-02-07得票数 0
回答已采纳
TL，DR:从狮身人面像扩展，我如何告诉sphinx-build将一个附加文件作为依赖处理？在我的直接用例中，这是扩展的源代码，但是这个问题同样适用于扩展名所使用的一些辅助文件。
我正在使用自定义扩展使用Sphinx生成文档。我正在使用sphinx-build构建文档。例如，我使用这个命令生成HTML (这是sphinx-quickstart生成的makefile中的命令)：
sphinx-build -b html -d _build/doctrees . _build/html
由于我的自定义扩展与文档的源代码一起维护，所以我希望sphinx-build将其视为生成的LaTeX (和L
浏览 0提问于2019-02-04得票数 0
回答已采纳
我从事一个Python项目，它是我使用Sphinx生成的html在线文档。该项目还包含了几个Python脚本，展示了如何使用所包含的工具的示例，同时对所有这些文件进行了广泛的注释，以解释其所发生的事情。
我现在也想将这些示例脚本包括在我的文档中，这样我就可以将它们作为教程重用，并且在我对代码进行更改时，不必同时修改示例和教程，而是可以将这两种东西直接结合在一起，并且始终是最新的。
我设想Sphinx从上到下解析脚本，并从中生成一个html文件，而注释则显示为页面上的文本，代码在代码块中进行描述。
你们中有谁知道这是怎么实现的吗？
非常感谢你的帮助！
浏览 2提问于2015-06-21得票数 6
我想开始使用来记录我的项目。我告诉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
回答已采纳
1回答
在我的Linux计算机上，我已经通过以下命令从构建了scipy
python setup.py build_sphinx
是什么在scipy/doc/source/generated文件夹中生成了一堆rst文件。
但是我如何访问这个文档呢？之前需要生成html文件吗？
浏览 2提问于2013-06-22得票数 3
回答已采纳
我想为我的访问者提供一个使用python-sphinx从RST生成的HTML页面中对表格中的单元格进行排序的可能性。假设我有一个这样的表： .. list-table:: A fancy name table
:header-rows: 1
* - Family name
- Given name
* - Smith
- Samuel
* - Johnson
- John 这将很好地呈现，并按输入的顺序显示名称。现在，我想生成一个HTML输出，并为用户提供按字母顺序重新排序名称的可能性。有standalone examples和库
浏览 17提问于2020-10-20得票数 2
我是编程新手，所以如果你需要更多的细节，请让我知道，但我一直难以将其输出到输出2而不是1。问题是我不知道如何阅读最后一段代码！
def sphinx_swap(start, goal, limit):
"""A diff function for autocorrect that determines how many letters
in START need to be substituted to create GOAL, then adds the difference in
their lengths.
""&#
浏览 0提问于2020-05-08得票数 0
1回答
搅拌器运行自己的Python。当我像这样编写Python代码时
import bpy
print(bpy.data.objects)
对于搅拌机来说，它运行的很好
$ blender --background --python my_code.py
<bpy_collection[3], BlendDataObjects>
但是，当我想用Sphinx和autodoc扩展来记录我的代码时，它不能导入bpy，因为它在Blender之外是未知的。
$ cd doc/
$ make html
[...]
ModuleNotFoundError: No module named 'b
浏览 0提问于2018-03-22得票数 0
我从命令行运行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，它似乎可以做我们需要的一切。然而，我有问题让它匹配所需的公司模板，这需要有一些前置网页插入之间的标题页和目录。
如果文本位于.rst文件中主目录的上方，则在HTML输出中将其置于目录上方，但在pdf输出中将其移至目录下方。我还尝试添加一个隐藏的toc，但也不起作用。内容也被放在非隐藏的目录之后。
.. toctree::
:hidden:
frontmatter
.. toctree::
:maxdepth: 2
contents_of_document
我知道这是必须的，因为人们已经使用这个工具出版了书籍，但我不知道
浏览 1提问于2016-04-24得票数 2
我正在使用sphinx在confluence.I中构建文档。我能够使用sphinx制作html文件。但是，当我尝试使用"make confluence“命令连接confluence时，它抛出了一个错误 我通过更改confluence密码进行了检查，并使用API token进行了检查，但仍然收到错误，无法与confluence连接。 参考链接- https://github.com/Shravankumarhiregoudar/sphinxDocumentation conf.py文件： # Configuration file for the Sphinx documentation
浏览 92提问于2021-10-25得票数 1
回答已采纳
如何让我的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回答
我一直在寻找教程在线设置斯芬克斯搜索，我已经让测试数据库工作。然而，我有困难，我自己的数据库工作。
sphinx.conf
source src1
{
type = mysql
sql_host = localhost
sql_user = root
sql_pass = MyPassword
sql_db = MyDatabase
sql_port = 3306
sql_query = \
SELECT listing_id, title, description, image
浏览 4提问于2015-09-07得票数 0
回答已采纳
2回答
我的公司正在使用狮身人面像为我们的产品制作手册。我们的产品带有PDF和HTML文档。我们使用Windows作为唯一的开发环境。
一个必要的要求是从相同的源(*.rst文件)生成两种格式。
遗留文档使用广泛的SVG，但是sphinx构建格式latex在\includegraphics{}环境中不支持SVG。
现在，我找到了有前途的狮身人面像扩展sphinx.ext.imgconverter，并将其包含在我的conf.py中。
extensions = [
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
浏览 0提问于2018-04-18得票数 5
我的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
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
