Sphinx docs / RST是否包含动态路径中的文件？
Sphinx docs / RST是一种文档生成工具，用于创建高质量的技术文档。它使用reStructuredText（RST）作为文档的标记语言。
关于Sphinx docs / RST是否包含动态路径中的文件，答案是可以的。Sphinx docs / RST支持使用动态路径引用文件。通过使用Sphinx提供的特殊指令和语法，可以在文档中引用其他文件或目录。
在Sphinx中，可以使用以下指令来引用动态路径中的文件：
.. include::：该指令用于将其他文件的内容包含到当前文档中。可以使用相对路径或绝对路径引用其他文件。.. literalinclude::：该指令用于将其他文件的内容以字面形式包含到当前文档中。同样可以使用相对路径或绝对路径引用其他文件。.. image::：该指令用于在文档中插入图片。可以使用相对路径或绝对路径引用图片文件。
通过使用这些指令，可以在Sphinx docs / RST文档中引用动态路径中的文件，包括其他文档、代码文件、图片等。
对于Sphinx docs / RST的优势，它具有以下特点：
- 简单易用：Sphinx docs / RST使用简洁的标记语言，易于学习和使用。
- 丰富的功能：Sphinx docs / RST提供了丰富的功能和扩展，如自动生成目录、索引、交叉引用等。
- 多输出格式：Sphinx docs / RST支持将文档输出为多种格式，包括HTML、PDF、EPUB等。
- 可扩展性：Sphinx docs / RST可以通过插件和扩展进行功能扩展，满足不同的需求。
Sphinx docs / RST在云计算领域的应用场景包括但不限于：
- 技术文档：Sphinx docs / RST适用于编写和生成各种技术文档，如API文档、用户手册、开发者指南等。
- 项目文档：Sphinx docs / RST可用于创建项目文档，记录项目的设计、实现、使用方法等信息。
- 文档协作：Sphinx docs / RST支持多人协作编辑文档，可以方便地进行版本控制和文档更新。
腾讯云提供了一款名为"云开发文档"的产品，可以帮助用户快速创建和管理技术文档。该产品基于Sphinx docs / RST，并提供了丰富的功能和工具，如在线编辑、版本管理、文档搜索等。您可以通过以下链接了解更多关于腾讯云云开发文档的信息：云开发文档
请注意，以上答案仅供参考，具体的产品选择和推荐应根据实际需求和情况进行评估。
相关·内容
我被蟒蛇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在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
回答已采纳
我正在尝试为测试Python项目创建文档，然后再为实际项目创建文档。我的系统: Win7 64位，python2.7.5 64位。
我的项目名是testDoc。它包括pakage，名为t，它包含2个模块t1和t2和__init__.py。
__init__.py包含：
import t1
import t2
t1.py包含：
'''
Created on 27 2013
@author:
'''
class MyClass(object):
'''
Hi
'''
浏览 0提问于2013-07-28得票数 16
回答已采纳
我使用的是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
回答已采纳
1回答
我有这个示例项目来学习狮身人面像是如何工作的。
目录结构如下所示：
.
+--app
| +--api
| +--endpoints
| +--address.py
|
|--docs
| +--conf.py
| +--index.rst
| +--source
| +--modules.rst
| +--address.rst
我在conf.py中将相关文件添加到我的路径中，如下所示：
import os
import sys
from pathlib import Path
project_root = Path(os.getcwd()).
浏览 3提问于2021-04-16得票数 0
回答已采纳
我正面临着一个奇怪的错误。这里我有一个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回答
我正在使用、sphinx、和RST生成一些技术文档作为HTML，并在获取本地PDF引用作为超链接时遇到问题。我见过人们使用:download:链接到本地PDF，但我将PDF嵌入到/docs目录中以供参考。我不喜欢:download:，因为它没有在浏览器中显示PDF内联，这需要代表用户使用额外的一步。
sphinx-build -b html不会复制任何文件，除非它们是在config.py、hook、html_static_path或html_extra_path中指定的-即使这样，它们也会被放到root目录或_static文件夹中。
是否有建议的方法将链接的二进制文件嵌入斯芬克斯，或者这是一个
浏览 4提问于2016-07-27得票数 12
回答已采纳
我想创建一个指向另一个文件中定义的节的链接。
我在"“上发现了一个类似的问题，我注意到有一个扩展名为"intersphinx”。所以我尝试了这个扩展，但它不起作用(可能我的用法是错误的)。
我已经尝试了以下几种方法。
conf.py
extensions = ['sphinx.ext.todo', 'sphinx.ext.intersphinx']
...
intersphinx_mapping = {'myproject': ('../build/html', None)}
foo.rst
...
*******
浏览 6提问于2013-07-11得票数 2
所以我把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
(另一种描述可以是“如何重命名斯芬克斯-autodoc包名？”)
在Python2.7.13上使用斯芬克斯版本1.7
我希望使用docstring和sphinx-apidoc自动创建文档。
我的项目结构如下：
myPythonProject <- my Python package name and git repository.
|-- docs
| |-- _build
| | |-- html <- where final HTML doc is created.
| |
| |-- apidocs <- cont
浏览 0提问于2018-03-21得票数 3
回答已采纳
我有一个托管在Github上的Python包，名为。我已经使用狮身人面像和.rst文件准备了我的文档。这些文件托管在GitHub 上。我能够成功地在本地运行make html并获得所需的输出。也就是说，文档的参考指南部分包含使用我在代码中包含的docstring自动生成的API，并使用对autoclass和autofunction ()的调用进行引用。
例如，下面是参考指南第一部分在本地呈现时的样子：
但是，当文档在readthedocs ()上呈现时，参考指南不包含提取的教条；只包含在.rst文件中找到的标题。
预期行为
我希望readthedocs上呈现的文档与本地呈现的文档相同
浏览 4提问于2020-12-29得票数 8
回答已采纳
我正在使用Sphinx创建一些文档，并且我希望使用bokeh.sphinxext将Bokeh图包含在文档中。考虑到，这似乎是一件容易的事情。但是，我想要用来生成地块的数据存储在CSV文件中。我尝试过将CSV文件放在同一个目录中，并在同一个RST文档中使用.. include:: data.csv，但这是行不通的。
在使用Sphinx创建Bokeh绘图时，如何引用外部文件？
.. include:: data.csv
.. bokeh-plot::
import pandas as pd
from bokeh.plotting import figure, output_fi
浏览 1提问于2018-10-18得票数 1
回答已采纳
我有一个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
我有一个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
回答已采纳
1回答
我已经编写了自定义的Ansible模块，并使用标准的Ansible约定对其进行了记录，即在模块文件中编写DOCUMENTATION和EXAMPLES全局字符串。
我已经有了一些使用Sphinx 1.8.3生成并在本地托管的文档。我希望将Ansible文档包含在Sphinx生成的页面中。我的目录结构相当简单：
./ansible/docs
├── conf.py
├── index.rst
├── _static
└── _templates
./ansible/library/
├── __init__.py
└── module.py
现在，我可以将文档编写为函数文档字符串，然后使用Sphi
浏览 2提问于2018-12-31得票数 0
回答已采纳
1回答
在使用RST编写的Sphinx项目中，有没有一种方法可以将文件排除在默认搜索功能之外？项目中的某些RST文件作为参考包含(例如许可文件)，但在搜索结果中没有用处。 是否有配置选项或指令指示Sphinx不索引特定的RST文件以包含在搜索结果中？
浏览 15提问于2020-12-02得票数 3
回答已采纳
我正在使用Sphinx来记录一个非Python项目。我希望在每个子模块中分发./doc文件夹，其中包含用于记录该模块的submodule_name.rst文件。然后，我想把这些文件吸进主层次结构中，为整个设计创建一个规范。
即：
Project
docs
spec
project_spec.rst
conf.py
modules
module1
docs
module1.rst
src
module2
docs
module2.rst
src
我试图将文件包含
浏览 15提问于2012-04-17得票数 118
回答已采纳
我在我的raw文件中包含了一个rst指令：
.. raw:: html
< html here >
在HTML中，有一个动态放置的字符串，其中包含reStructuredText。因为它被放置在raw指令中，所以它不会呈现为reStructuredText，而是保持为reStructuredText。
因此，如何访问sphinx的呈现函数，使我能够手动生成raw指令之外的HTML？
我读了几个狮身人面像的文件，但我可能缺乏一些基本的信息。
我的理解是：
jinjia用于模板的呈现，而不是文件的转换。
狮身人面像有各种构建器，其中一个是html构建器(例如make h
浏览 0提问于2018-09-12得票数 0
回答已采纳
我有一个具有以下结构的项目(我想保留这个结构)：
my_project
├── build # here is where sphinx should dump into
├── requirements.txt
├── make.bat
├── Makefile
├── ... # more config files
├── doc # this is where I want sphinx files to live
│ ├── conf.py
│ └── index.rst
├── src
│ └── my_project
│ ├── __init__.py
浏览 2提问于2018-04-17得票数 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
我将文档添加到我的Django项目(，该项目是开源的)，使用sphinx，但是当我尝试生成python文件的autodoc时，我会发现很多bug。我包含一个带有docstring的models.py文件，但是，当运行make html时，我会得到不同的bug。我做了一些修改，bug正在改变，但我不确定是修复它们，还是只生成一个新的bug。如果删除了models.py文件的包含，则所有操作都运行得很完美。换句话说，只有在.rst文件中包含以下行时才会生成bug：
.. automodule:: account.models
:members:
让我给你看看我做了什么。
当我运行mak
浏览 2提问于2018-06-15得票数 9
回答已采纳
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
回答已采纳
1回答
我在一个包含rst的automodule文件上运行狮身人面像，但它似乎没有任何效果。
下面是详细信息:我有一个Python项目，其中包含一个包含类agent.py的文件Agent。我还有一个子目录apidoc，其中包含一个文件agent.rst (由sphinx-apidoc生成)：
agent module
============
.. automodule:: agent
:members:
:undoc-members:
:show-inheritance:
我使用sphinx-build -b html apidoc apidoc/_build运行狮身人面像，项目
浏览 4提问于2020-01-24得票数 6
回答已采纳
1回答
我希望包含一个setuptools命令来运行Sphinx，作为包setup.py的一部分，如下所示：
$ python setup.py sphinx_doctest
我有一个包结构，如：
my_pkg
|---__init__.py
|---module1.py # Containing reStructuredText docstrings with examples
docs
|---build
|---|---doctrees
|---source
|---|---conf.py # Sphinx config
|---|---index.rst # Sphinx index
浏览 3提问于2015-07-24得票数 3
回答已采纳
我正在使用Sphinx从py模块生成一个类图。根据Sphinx文档，我在RST文件中为我希望绘制的模块使用了继承图指令。但是，构建只生成Graphviz标记，而不是实际的绘图。我已经在我的Sphinx配置文件中包含了inheritance_diagram和Graphviz。为了获得图形输出，我还需要其他指令吗？谢谢。
浏览 0提问于2015-03-20得票数 2
可以在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
当我运行sphinx-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？
下面是我想要制作的一个文档页面示例(注意TOC)：
据我所知，这是由于sphinx源代码中的apidoc.py文件(第88行)：
我可以手动编辑每个单独的.rst文件来删除这些标题，或者只是从脚本中删除这些代码行，但是接下来我必须编译Sphinx源代码。在不手动编辑Sphinx源代码的情况下，是否有一种自动完成此操作的方法？
浏览 2提问于2014-01-08得票数 18
回答已采纳
我的项目结构如下：
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
我有以下两门课：
class Test1():
"""Test1()"""
def fn_test1():
"""fn_test1 """
print "Hello1"
。
class Test2():
"""Test2()"""
def fn_test2():
"""fn_test2 """
浏览 1提问于2014-09-05得票数 3
我正在使用Sphinx在多个目录中记录autodoc模块。我已经有了每个Python模块的rst文件，并且可以在声明包含Python模块的某个目录的路径时使用autodoc，但我正在尝试记录来自两个不同目录的Python模块。在conf.py文件中，我使用了：
sys.path.insert(0, os.path.abspath("../python_modules_A"))
但是我希望同时拥有python_modules_A和python_modules_B的路径，因为我的模块都在这两个目录中。
鉴于我的项目团队的结构，我希望避免将模块重新组织到一个目录中，因为它们在pyth
浏览 0提问于2017-02-14得票数 1
我用python开发了一个包，并使用Sphinx为它创建了文档。
文件夹结构的相关部分如下：
my_package
setup.py
my_package
my_module.py
docs
index.rst
_build
html
index.html
包将托管在局域网中的某个位置，这是PYTHONPATH所提到的。我的最终用户将使用import my_package访问我的包。他们不知道文档(或相应的包)位于何处。使用help(my_package)只会向用户展示模块中的文档。
所以，我想知道如何允许我的最终用户访问inde
浏览 1提问于2017-03-31得票数 3
回答已采纳
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
回答已采纳
我在GitHub上有一个README.rst，它也被合并到一个Python项目的Sphinx生成的文档中。我想在文件的顶部添加一条注释，该注释将显示在GitHub上(它只是呈现.rst)，但不会显示在由Sphinx生成的文档中。
我知道可以使用.. blah blah blah在.rst文件中包含注释，但是有没有什么方法可以包含只被Sphinx视为注释的行呢？(或者，让Sphinx忽略该行。)
浏览 0提问于2016-03-07得票数 3
1回答
我正在使用Python (通过)。
我有一个包含几个子模块的存储库，我正在尝试创建一个统一的文档，但仍然将文档资产单独保存在每个模块中。
我的文件夹层次结构是：
MyProject
docs
index.rst
module_1_link.rst
_static
<more irrelevant assets...>
module_1
docs
README.rst
_static
myimage.png
index.rst文件如下所示：
.. toct
浏览 1提问于2018-09-02得票数 8
我正在做一个非常简单的例子，却无法让它发挥作用。我只有一个文件，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
回答已采纳
我正在尝试开始使用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和/或RST ..include::指令中使用动态路径？
我这样做的原因是，我在一个存储库中有一些由Sphinx生成的开发人员文档，但我们在另一个存储库中有一堆单元测试，我们希望将它们包含在文档中。如果我知道另一个存储库中文件的路径，这是非常标准的，如下所示：
Some text in my RST file
.. include:: ../path/to/other/repo/file.py
:code: python
Some more text
问题是到其他存储库的相对路径并不总是相同的，这取决于克隆和安装的方式。例如，在读取文档时，另一个存储库通过re
浏览 12提问于2017-07-14得票数 3
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
回答已采纳
我有一个基本的ReadTheDocs存储库。根据构建页面的建议，我试图使用.readthedocs.yml来配置它：
配置您的文档生成！向项目中添加.readthedocs.yml文件是配置文档生成的推荐方法。您可以声明依赖项、设置子模块和许多其他伟大的特性。
我添加了一个基本的.readthedocs.yml
version: 2
sphinx:
builder: dirhtml
fail_on_warning: true
然后出现了构建失败：
项目配置中的问题。无效的"sphinx.builder"：.readthedocs.yml:您的项目在管理仪表板
浏览 1提问于2020-02-23得票数 4
我用狮身人面像做文件。当我使用“”时，我从index.rst文件中得到以下警告。
如何删除这些警告？此外，由于这些警告，内容表没有在汇合中工作，但是文档正在代码中创建。
任何建议/帮助都是非常值得赞赏的。
[4px@learning-2 docs]$ make confluence
Running Sphinx v4.2.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [confluence]: targets for 0 so
浏览 4提问于2021-10-26得票数 2
回答已采纳
我有一个项目，包括Python包以及一些Matlab代码，这些代码都应该包含在Sphinx创建的相同文档中。文档中的Python部分在相当长的一段时间内运行得非常完美--现在添加了Matlab部分，造成了一些麻烦。
数据结构大致如下：
|- python
|- modules
|- including subpackages
|- some sub-modules
|- matlab
|- scripts
|- functions
|- docs
|- source
浏览 9提问于2022-02-18得票数 0
回答已采纳
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
我试图使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。
我有很多模块，我希望每个模块只显示类名，而不是类中的完整方法列表(所有这些方法都在我的代码中有文档字符串)。
下面是我的conf.py文件的一个片段：
sys.path.insert(0, '/blah/sphinx/src')
extensions = ['sphinx.ext.autodoc']
autodoc_member_order = 'bysource'
autodoc_default_flags =
浏览 7提问于2016-04-02得票数 8
回答已采纳
3回答
我试着用狮身人面像记录我的一个项目。我在所有模块和文件中都使用了autodoc字符串。我使用sphinx为我的代码自动生成rst文件。到现在为止还好。
问题是，狮身人面像无法导入任何模块，即使我已经将项目添加到sys.path中。
我的单元测试通过并可以导入我的模块。我有点不知所措；我尝试过各种重命名、移动、重新加载和重新配置，但都没有成功，至少可以说是非常令人沮丧的。
这是我的文档结构：
project
├── collectionprocessor.py
├── config.py
├── createdb.py
├── database
│ ├── database.py
│ └
浏览 4提问于2014-05-08得票数 7
回答已采纳
我试着把我做过的代码的文档放在readthedocs上，但是所有的页面都变成了空白。我已经尝试了一整天，我已经看了/读了几十个教程，但都没有成功的迹象。当我在本地执行时，它可以正常构建。 目录的组织方式如下： /root: /docs，module1.py，module2.py，module3.py，.readthedocs.yml 根/文档: /_build、/_static、/_templates、conf.py、index.rst、make.bat、Makefile、requirements.txt、module1.rst、module2.rst、module3.rst 我将在下面留下
浏览 82提问于2021-11-05得票数 0
2回答
我正在使用PyCharm编写一个Python项目，现在我需要生成相应的API文档。我正在使用docstrings记录代码方法和类。我读到了狮身人面像和氧气，斯芬克斯现在是最受推荐的。我试着配置狮身人面像PyCharm，但是我没有办法让它正常工作。
这是项目结构
这是与命令Sphinx 的I/O交互。
C:\Python\Python36\Scripts\sphinx-quickstart.exe
Welcome to the Sphinx 1.6.3 quickstart utility.
Please enter values for the following settings
浏览 11提问于2017-09-21得票数 8
回答已采纳
这是一个如何/最佳实践的问题。
我有一个代码库，它有一套用pytest运行的单元测试。
我有一组*.rst文件，这些文件提供了每个测试的说明，以及一些数学图的结果和图像表。
每次pytest套件运行时，它都会用最新测试数据的结果动态更新*.rst文件、更新数值、在测试中加盖时间戳等等。
我想将它与项目文档集成起来。我可以
每当我想查看测试结果时，都要用sphinx-build分别构建这些rst文件--这似乎很糟糕，因为它需要大量的劳动，而不是自动化的。
告诉Sphinx单独呈现这些页面，并将它们更好地包含在项目文档中，但我不知道如何配置这些页面
为测试结果提供一
浏览 0提问于2019-06-23得票数 2
我使用sphinx在readthedocs中构建了一组rst文件。文件有多个项目符号列表，但它们未正确呈现。
文本将出现，但没有项目符号或嵌套/缩进。
为了确保这不是我的文件，我直接从sphinx_rtd_theme页面()进行了复制粘贴
这就是rst应该呈现的内容(对于html文件中的每个列表项，使用::marker )
这是我使用本地的sphinx / rtd设置构建相同的rst时得到的结果
我的conf.py或其他文件中有什么需要修复的吗？
浏览 6提问于2021-05-15得票数 5
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的新手，我想编写Python包的文档。当我想要包含一个演示文件时，我遇到了问题。
我想使用扩展名demo.ipynb包括文件nbsphinx。它已成功安装在我的计算机上。狮身人面像的conf.py文件中的扩展名变量包含以下行：
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.githu
浏览 0提问于2019-03-22得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
