在生成sphinx构建文档期间检测conf.py中的输出格式
，可以通过以下步骤进行：
- 确保已安装Sphinx：Sphinx是一个用于生成文档的工具，可以通过pip安装。具体安装步骤可以参考Sphinx官方文档。
- 打开conf.py文件：在Sphinx项目的根目录下，可以找到名为conf.py的文件。该文件是Sphinx的配置文件，用于指定文档生成的各种参数。
- 检查输出格式配置：在conf.py文件中，可以找到一个名为html_theme的配置项，该项用于指定生成文档的输出格式。默认情况下，Sphinx使用的是"alabaster"主题，可以根据需要修改为其他主题。
- 配置其他参数：除了输出格式外，conf.py文件中还可以配置其他参数，如文档标题、作者、版本号等。根据需要进行相应的配置。
- 生成文档：保存并关闭conf.py文件后，可以使用Sphinx命令生成文档。在命令行中切换到Sphinx项目的根目录，并执行以下命令：
sphinx-build -b html sourcedir builddir其中，sourcedir是源文件目录，builddir是生成文档的目标目录。执行该命令后，Sphinx将根据conf.py中的配置生成文档。
总结： 在生成sphinx构建文档期间检测conf.py中的输出格式，需要打开conf.py文件并检查html_theme配置项，根据需要修改为其他主题。除了输出格式外，还可以配置其他参数。最后使用Sphinx命令生成文档。更多关于Sphinx的详细信息和使用方法，可以参考腾讯云的Sphinx产品介绍链接：Sphinx产品介绍。
相关·内容
在我的buildout.cfg文件中，有这样的代码：
parts =
...
sphinxbuilder
下一个文件是：
eggs=
...
jinja2
markupsafe
sphinx
然后，在文件的末尾：
[sphinxbuilder]
recipe = collective.recipe.sphinxbuilder
source = ${buildout:directory}/docs-src
build = ${buildout:directory}/docs
我知道：
bin/buildout
它提供输出(一般为: OK)：
Updatin
浏览 2提问于2016-02-04得票数 10
1回答
在运行sphinx-build -b latex ...时，Sphinx会将一个*.tex文件写入某个输出目录。该*.tex文件的名称似乎以某种方式派生自conf.py中的project标题集。
我希望将Sphinx Latex一代集成到我的构建系统中。对于依赖项管理，我需要知道生成的*.tex文件的确切名称。
有没有办法确定生成的文件的名称，而不将该名称硬编码到构建系统中？或者，是否有办法手动设置此名称(无需更改project变量)？
浏览 14提问于2021-02-27得票数 1
我的项目结构如下：
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
1回答
我正在从Sphinx生成一个LaTeX文档，并使用pdflatex (来自MikTeX)将其转换为PDF。文档在PDF查看器的侧边栏中缺少一个目录。
如果我将手动\usepackage{hyperref}添加到tex文件中，它就能工作。但是我如何让狮身人面像在conf.py项目文件中这样做呢？乳胶输出选项中没有(明显的)相关选项。
谢谢!
浏览 2提问于2015-09-01得票数 4
回答已采纳
我想使用事件来选择某个python类上的一部分成员用于文档。
但在sphinx文档中并不清楚，我也找不到任何示例来说明:我应该将连接它的代码放在哪里？我在我的conf.py中看到了，但当我在conf.py中尝试这段代码的变体时，我找不到我应该连接的应用程序对象()：
def maybe_skip_member(app, what, name, obj, skip,
options):
print app, what, name, obj, skip, options
return False
# This i
浏览 1提问于2010-09-21得票数 32
回答已采纳
2回答
我已经为我的项目设置了Sphinx文档，并希望提取源文件的文档字符串并将它们嵌入到最终文档中。不幸的是，Sphinx不支持源文件的语言(VHDL)。VHDL似乎没有狮身人面像域。
因此，我的想法如下：
钩入Sphinx，运行并在Sphinx之前执行一些Python代码
Python代码从每个源文件(最顶层的多行注释块)中提取文本块，每个源文件组装一个reST文件，包括这个注释块和其他一些reST标记。
所有源文件都列在一个index.rst中，以生成.. toctree::指令。
每个源代码目录都递归地进行文本提取和转换。
因此，主要的问题是：如何连接到Spinx?
还
浏览 2提问于2016-05-24得票数 11
回答已采纳
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
回答已采纳
1回答
我维护一个用C++编写的小型库项目。我想使用Sphinx来维护库网站+每个版本的用户文档。我在邮件列表上发现了(类似的问题)，但没有进行广泛的跟踪。
如何管理多个版本？
我想到这样的基本结构：
mylib/ <- website root
mylib/...
mylib/tutorial/...
mylib/doc <- list of documentation per release version
mylib/doc/1.0.0
mylib/doc/2.0.0
mylib/doc/X.Y.Z
我试图为这个结构找出最好的实用配置。我有根配置mylib/conf.py
浏览 4提问于2011-10-21得票数 11
我们不想维护文档和源代码，因为源代码目前正在快速发展，但是Sphinx似乎需要大量令人沮丧的设置和配置。(我们只需要一些基本的API文档。)难道没有一个命令可以在python项目中运行，它只会迭代生成HTML文档的所有包、模块、类和函数吗？
sphinx将内容拆分到一个目录中，在修改conf.py使我们的包在sys.path中后，我们可以运行"make“，但它只列出包和模块，而不记录任何类或函数。
谢谢!
浏览 8提问于2013-02-26得票数 16
我想开始使用来记录我的项目。我告诉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-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
我目前正在使用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
回答已采纳
1回答
我在尝试将Sphinx autodoc用于python包时遇到了很多困难，我认为这个问题是路径问题，但我不知道如何解决这个问题。想知道会不会有人知道？
我只是用一个超级基本模块设置，在“main.py”中安装了一个my_project，看起来像：
在以下两种情况下，我只有一个基本的conf.py和index.rst文件：
场景1(工作正常)
当我使用sphinx-quickstart命令构建文件夹树并指定'N'时，当询问我是否想分离源目录和构建目录时，它似乎都工作得很好，并且我能够成功地构建html，它可以在没有问题的情况下找到和读取my_project.main
浏览 9提问于2022-09-20得票数 0
虽然这将解决的最终问题是TeX问题(为PDF输出安装新字体)，但我正在寻找的这个特殊解决方案是一个Sphinx问题。Sphinx在制作PDF时使用标准的LaTeX，到目前为止还不错，但是我需要安装一个新的字体，并且已经尝试过了，但失败了。我知道使用XeLateX的过程要简单得多，所以我想知道是否有扩展或某种方法可以配置Sphinx，使其使用XeLaTeX构建器。
浏览 0提问于2012-08-13得票数 5
回答已采纳
1回答
尽管阅读了、和，我还是无法让sphinx autodoc很好地处理numpy文档字符串。
在我的conf.py中，我有：
extensions = ['sphinx.ext.autodoc', 'numpydoc']
在我的doc文件中，我有：
.. automodule:: python_file
.. autoclass:: PythonClass
:members:
其中，python_file.py具有：
class PythonClass(object):
def do_stuff(x):
""
浏览 19提问于2013-12-03得票数 23
如何在Pygments突出显示的Sphinx代码片段的HTML输出中设置制表符宽度？默认情况下是恼人的8，但我想要4。我在Sphinx conf.py中找不到任何关于这个设置的单词。
浏览 0提问于2009-11-06得票数 6
回答已采纳
我最新的狮身人面像文档在试图用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添加一个新的输出格式，那么可能需要向所有现有的Sphinx扩展添加特例代码吗？
例如，我看到“todo”扩展似乎尝试并使用警告，但必须有特例乳液代码--我是否必须对其他人可能使用的每个扩展做类似的操作，除非我可以做一些类似的操作来重用现有的格式化功能？
浏览 1提问于2018-04-23得票数 1
回答已采纳
我在Windows上使用狮身人面像。
我的大部分文档都是为普通用户编写的，但是有些子页面的内容仅供管理员使用。因此，我想构建我的文档的两个版本:一个完整版本，第二个版本，不包括"admin“页面。
我用来做这个。
到目前为止，它起作用了。当我将其名称包含"admin“的每个子文件夹中的每个文件放入conf.py文件时，都会忽略该文件：
exclude_patterns = ['**/*admin*']
问题是，为了获得这两个版本，我想一次运行构建一次。
我现在要做的是运行两次make.bat并在每次运行中提供不同的参数。
根据，我可以通过设置BUILDDIR和S
浏览 9提问于2012-11-23得票数 6
回答已采纳
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
我在GitHub上有一个README.rst，它也被合并到一个Python项目的Sphinx生成的文档中。我想在文件的顶部添加一条注释，该注释将显示在GitHub上(它只是呈现.rst)，但不会显示在由Sphinx生成的文档中。
我知道可以使用.. blah blah blah在.rst文件中包含注释，但是有没有什么方法可以包含只被Sphinx视为注释的行呢？(或者，让Sphinx忽略该行。)
浏览 0提问于2016-03-07得票数 3
sphinx支持选项-隐式名称空间来根据PEP420处理命名空间包。当我用"python setup.py build_sphinx“创建狮身人面像文档时，默认情况下，这并不适用于命名空间包。"python setup.py build_sphinx“和sphinx之间是否有关系(例如，在运行"python setup.py build_sphinx”时，sphinx是否在某个地方隐式调用？)如果是这样的话，我是否可以专门说明"python setup.py build_sphinx“应该考虑斯芬克斯-apidoc的隐式名称空间选项？
浏览 6提问于2017-06-26得票数 0
我正在使用狮身人面像( 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
回答已采纳
1回答
按照Sphinx (由matplotlib作者编写)，我在定制外观和感觉时遇到了问题。
该项目构建时没有错误，但不是这样。
我看到这个
或者如果我缩小窗户，这个
(项目名称由我编辑)。
我试过打开sphinx-build的详细输出，但没有任何提示可能出错。
浏览 1提问于2016-01-18得票数 1
回答已采纳
我对狮身人面像很陌生。我在Sphinx官方文档站点上阅读了一些有关它的内容，并按照以下步骤在我的Debian Wheezy服务器上安装和配置它：
首先，我已经在上安装了狮身人面像源。
安装狮身人面像
我已经执行了配置根目录和conf.py的脚本conf.py。
狮身人面像-快速启动
我已经执行了make html命令，用于在我的目录路径中构建HTML。
使html
我已经安装了Sphinx自动构建，用于处理文档的每一次更改/更新，就像@ 编写的那样。
pip安装狮身人面像-自动构建
sphinx-自动构建源代码构建/html
我已经修复了
我的第
浏览 2提问于2017-03-26得票数 4
回答已采纳
如何让我的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中给出一个量子公式。LaTeX代码： \ket{\psi}=\frac{1}{\sqrt{2}}(\ket{00}+\ket{11}) 看起来需要来自LaTeX的'physics‘包。如何在Sphinx中添加此包？ 我试图通过添加两行来修改Sphinx的conf.py。但它不起作用。 # -- Options for LaTeX output -------------------------------------------------
latex_engine = 'xelatex'
latex_elements = {'preambl
浏览 50提问于2021-01-18得票数 1
回答已采纳
我正在使用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
回答已采纳
我最近对我的一个项目进行了Cython化，将所有模块(顶级__init__.py除外)重命名为*.pyx，并将ext_modules = [Extension('foo', ['foo.pyx'])]放在setup.py中。构建和安装工作正常。然而，当我执行cd doc; make html时，Sphinx失败了，因为它不能导入任何现在是*.pyx的模块。
如果我编辑doc/conf.py并将sys.path.insert(0, os.path.abspath('..'))更改为sys.path.insert(0, os.path.abspath
浏览 3提问于2012-04-08得票数 23
回答已采纳
我构建了一个Sphinx文档，该构建在本地运行良好。我的文档字符串如下所示。 ? 在迁移到readthedoc.io时，我在docs/requirement.txt下添加了一个特定的需求文件，该文件是： sphinx==3.5.4
sphinx_rtd_theme==0.5.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcon
浏览 35提问于2021-05-11得票数 1
回答已采纳
我正在使用Sphinx和readthedocs为python项目构建文档。由于某些原因，代码块在构建文档后不会呈现，内联代码(标记为backticks)显示为斜体。我已经检查了原始构建，有一个警告，无法找到exomagpy模块，我通过更改"..“来解决这个问题。在os.path.abspath()部分的conf.py中，这似乎没有改变文档中的任何内容。在堆栈溢出上有一个类似的问题，我尝试了解决方案，但它没有改变。
原始构建可以在这里找到：
这些文档是从github页面的“开发”分支构建的(下面的链接)
下面是指向github页面的链接：
回购的结构如下：
>.vscode
>
浏览 4提问于2022-07-29得票数 3
回答已采纳
我对非常陌生，我正在尝试为我的应用程序创建文档。最好为每个主题生成一个“独立”的HTML文件。
我的意思是: Sphinx在左侧创建一个有用的导航面板，其中包含一些模块(toc、下一个主题、搜索等)。但这是放置在每一个HTML！
我想在我的应用程序中添加一个上下文帮助:每当用户将焦点设置在(相关的)小部件上时，相关的HTML就会显示在一个框中。当然，我不想在这里显示导航面板！
是否可以将Sphinx配置为生成仅包含主题内容的HTML文件，然后使用主html (index.html)将它们显示在框架中？
浏览 3提问于2017-10-08得票数 0
回答已采纳
有没有办法用Sphinx在rst文件中渲染MathML？
我在conf.py中启用了mathjax扩展。它使用like与latex配合得很好
但是，如果我用数学ML替换它，它确实会呈现它，但会显示所有的xml代码。例如,
产生
在Sphinx中，数学是由mathjax扩展呈现的。在上，mathjax声称他们支持MathML。
浏览 1提问于2018-05-26得票数 3
我知道下面的代码为所有模块生成rst，但不包括index.rst
sphinx-apidoc -f -o very_good_docs/ very_good
下面的代码生成所有内容，包括index.rst、conf.py、Makefile等
sphinx-apidoc -F -f -o very_good_docs/ very_good
问题是sphinx-apidoc不能生成正确的conf.py，所以我必须总是手动修改conf.py以包含正确的sys.paths。如果我在"very_good“文件夹中修改我的python代码，我应该运行不带"-F”的sphinx-apidoc
浏览 4提问于2014-02-18得票数 2
我面临着一个奇怪的问题。我向我的项目中添加了最新的sphinx_rtd_theme文件，并完成了所需的主题重写(包括在表中包装的著名文本)。
当地的建筑工程非常好。但是它被推到了主人那里，主题回到了非常基本的地方，而且没有得到应用。我试过手工构建，但仍然无法找到根本原因和解决办法。
我指的是在ReadTheDocs网站(帐户)上创建的构建。
浏览 4提问于2017-04-23得票数 1
回答已采纳
我是个初学者，也许这个问题听起来很蠢，但无论如何：
我正在使用狮身人面像，我想在html_static_path文件中设置config.py变量。
默认情况是：
html_static_path = ['_static']
我的项目设置是：
docs/
build/
doctrees
html/
_static/
source/
conf.py
sphinx文档指出，我需要设置相对于此目录的路径，即来自conf.py的rel路径。所以我试着：
html_static_path =
浏览 3提问于2022-01-17得票数 1
回答已采纳
我是Sphinx的新手，在完成我的文档之后，我注意到搜索栏已经消失了，而以前它还在那里。
我没有(有意地)更改conf.py文件中的任何内容，也不确定为什么会发生这种情况。
有谁知道怎么把它找回来吗？
浏览 4提问于2017-08-16得票数 1
我在使用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
1回答
最近，我通过项目的sphinx_autodoc_typehints开始使用狮身人面像的sphinx_autodoc_defaultargs扩展和。看起来，在readthedocs上的sphinx安装中并不是默认的包( sphinx在v1.8.5上)。因为我的构建失败了，Extension error显示了
Could not import extension sphinx_autodoc_typehints (exception: No module named
'sphinx_autodoc_typehints')
我知道我必须告诉readthedocs从sphinx_au
浏览 11提问于2021-07-12得票数 2
我使用sphinx在readthedocs中构建了一组rst文件。文件有多个项目符号列表，但它们未正确呈现。
文本将出现，但没有项目符号或嵌套/缩进。
为了确保这不是我的文件，我直接从sphinx_rtd_theme页面()进行了复制粘贴
这就是rst应该呈现的内容(对于html文件中的每个列表项，使用::marker )
这是我使用本地的sphinx / rtd设置构建相同的rst时得到的结果
我的conf.py或其他文件中有什么需要修复的吗？
浏览 6提问于2021-05-15得票数 5
我正在尝试在sphinx中创建一个模板。我的目的不是使用基本的模板，而是从头开始构建一个新的模板。然而，关于哪些变量从sphinx传递到模板的(/no)文档非常少。
我想转储所有从sphinx传递给模板的变量。(理想情况下是在模板中，因为我的python知识不是很好！)
浏览 8提问于2016-07-18得票数 0
回答已采纳
可以在conf.py中指定Sphinx构建的主文档的路径。但是，此目录路径反映在生成的HTML中，例如，在“将文档作为缺少的索引读取”中显示。我想使用这种替代方法来整洁地构建我的项目--在顶层进行配置并在src中编写文档，但在构建过程中从根本上摆脱它。
所以这是我之前得到的：
docs
conf.py
index.rst
things
doc1.rst
doc2.rst
这是可行的，但是当很多文件被添加到顶层时，它会弄乱Sphinx的makefile等等。
docs
conf.py
src
index.rs
浏览 19提问于2020-02-28得票数 1
我想在带有路径的conda虚拟环境中的库上运行sphinx。
/anaconda/envs/test_env/lib/site-packages/mypackage
并将html文件放到路径中。
/myhtmlfiles/myproject
我的conf.py和*.rst文件在其中的路径
/sphinx/myproject
问题
当我运行时，我需要编辑哪些conf.py设置来实现这一点？
make html
浏览 4提问于2016-10-14得票数 5
我已经编写了一个Python模块，包括一个用C编写的子模块:模块本身称为foo，C部分是foo._bar。结构看起来像这样：
src/
foo/__init__.py <- contains the public stuff
foo/_bar/bar.c <- the C extension
doc/ <- Sphinx configuration
conf.py
...
foo/__init__.py导入_bar对其进行扩充，有用的内容在foo模块中公开。这在构建时可以很好地工作，但显然不能以未编译的形式工作，因为
浏览 1提问于2011-01-14得票数 7
回答已采纳
我们正在使用Python-Sphinx来构建我们的最终用户手册。 为了自动转换我们分类的图形文件格式，就像我们使用Sphinx扩展sphinx.ext.imgconverter一样，它利用ImageMagick将我们的图形文件格式转换为给定构建目标可以理解的图形格式。 有关详细信息，请参阅：sphinx.ext.imgconverter 不幸的是，转换后的图像的输出不能满足我们的需求。一个主要问题是转换后的图像分辨率较低，这会产生像素化的结果。 因此，我在conf.py中包含了下面这行代码 image_converter_args=["-density 300"] 现在，构建
浏览 2提问于2019-04-30得票数 0
回答已采纳
3回答
在狮身人面像中，我不能参加待办事项列表。以下是我所拥有的：
.. todo:: blah blah blah
conf.py
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
]
我尝试了sphinx.ext.todo=True中的conf.py，但是当我使用make html时会出现语法错误。
浏览 3提问于2014-03-10得票数 7
回答已采纳
我使用的是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
回答已采纳
我正面临着一个奇怪的错误。这里我有一个Django项目，它在本地运行得很好，我甚至生成了文档，一切都很顺利。问题是，当我在中导入项目时，编译失败了，我几乎什么都试过了，但始终是同一个问题。
我使用Django == 2.2 Python == 3.7.8
我的项目结构：
- Myproject
-- docs
-- build
-- source
- conf.py
- index.rst
- file.rst
- another_file.rst
make.bat
Makefile
浏览 0提问于2020-09-14得票数 1
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回答
我正在用以下方式为django项目构建我的sphinx文档：
sphinx-apidoc app -o docs/source/app --force
现在它包含了我不想在我的文档中包含的所有南向迁移。我现在尝试通过以下方式排除它们：
conf.py:
def skip_migrations(app, what, name, obj, skip, options):
return skip or (what == 'module' and name.find('Migration') != -1)\
or
浏览 74提问于2013-05-08得票数 8
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
