构建模块目录的正确方法是什么，以便Sphinx扩展autodoc可以访问使用sphinx-apidoc找到的所有文件？
构建模块目录的正确方法是按照一定的规范和结构组织代码文件，以便Sphinx扩展autodoc可以访问使用sphinx-apidoc找到的所有文件。以下是一种常见的构建模块目录的方法：
- 创建一个顶级目录，用于存放整个项目的代码文件和文档。
- 在顶级目录下创建一个名为"docs"的子目录，用于存放项目的文档。
- 在"docs"目录下创建一个名为"source"的子目录，用于存放Sphinx文档的源文件。
- 在"source"目录下创建一个名为"modules"的子目录，用于存放项目的模块文档。
- 在"modules"目录下创建一个名为"api"的子目录，用于存放自动生成的API文档。
- 使用sphinx-apidoc工具生成API文档，并将生成的.rst文件保存到"api"目录中。
- 在"source"目录下创建一个名为"index.rst"的文件，用于编写项目的主文档。
- 在"index.rst"文件中使用autodoc扩展指令，引入生成的API文档。
- 在"index.rst"文件中编写项目的其他文档内容。
- 在"docs"目录下运行Sphinx命令，生成项目的文档。
通过按照上述方法构建模块目录，可以使Sphinx扩展autodoc能够正确地访问和生成项目的API文档。这样，开发人员可以方便地查看和使用项目的各个模块，并且可以通过Sphinx生成的文档进行项目的文档化和说明。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云文档：https://cloud.tencent.com/document/product
- 腾讯云API网关：https://cloud.tencent.com/product/apigateway
- 腾讯云函数计算：https://cloud.tencent.com/product/scf
- 腾讯云对象存储：https://cloud.tencent.com/product/cos
- 腾讯云数据库：https://cloud.tencent.com/product/cdb
- 腾讯云容器服务：https://cloud.tencent.com/product/ccs
- 腾讯云人工智能：https://cloud.tencent.com/product/ai
- 腾讯云物联网：https://cloud.tencent.com/product/iot
- 腾讯云移动开发：https://cloud.tencent.com/product/mad
- 腾讯云区块链：https://cloud.tencent.com/product/bc
- 腾讯云元宇宙：https://cloud.tencent.com/product/mu
相关·内容
1回答
是否可以使用sphinx-apidoc在同一个git存储库中为多个包创建文档？
python、python-sphinx、read-the-docs、namespace-package、sphinx-apidoc
我有一个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
2回答
在制作sphinx autodoc时如何忽略python项目中的src目录
python、python-sphinx、setup.py、autodoc
(另一种描述可以是“如何重命名斯芬克斯-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
回答已采纳
1回答
将代码文档和代码混合起来，在节中添加不同的注释？
python、documentation、python-sphinx、documentation-generation、code-documentation
考虑以下最小的示例：
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
回答已采纳
1回答
sphinx-apidoc使用.多源python目录
python、python-sphinx、sphinx-apidoc
所以我把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
1回答
如何在嵌套目录中生成狮身人面像码头？
python、python-sphinx、autodoc
我想从嵌套文件夹结构中的脚本中生成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
1回答
如何在__init__.py中将Sphinx autodoc配置为文档类？
python、python-sphinx、autodoc、numpydoc
我有带有NumPy文档字符串的Python代码。设法将Sphinx用于应用程序接口文档，但是，__init__.py文件中的类没有成功记录。
示例：xxx/__init__.py
from __future__ import annotations
import sys
import re
from typing import Iterator, ...
import pyparsing as p
__all__ = ['Xxx']
class XxxData:
"""It is a class XxxData."""
浏览 8提问于2021-06-12得票数 0
2回答
genindex和modindex页脚链接在readthedocs.io中不起作用
python-sphinx、restructuredtext、read-the-docs、autodoc
我有一个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回答
从不工作的docstring生成sphinx docu
python、python-sphinx
我有一个具有以下结构的项目(我想保留这个结构)：
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
回答已采纳
1回答
狮身人面像找不到我的项目的根模块
python、windows-10、python-sphinx
我有这个示例项目来学习狮身人面像是如何工作的。
目录结构如下所示：
.
+--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
回答已采纳
1回答
如何使Sphinx自动文档在源目录之外生成？
python、documentation、python-sphinx
我的项目结构如下：
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
2回答
如何使用Python生成HTML文档？
python、pycharm、python-sphinx、autodoc、sphinx-apidoc
我正在使用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
回答已采纳
3回答
python-sphinx记录不带py扩展名的脚本
python、python-sphinx
抱歉--这是一个完整的n00b问题：
我有几个没有.py扩展的python脚本。
如何让Sphinx相信它应该记录该脚本？示例错误：
/home/XXX/YYYYY/development/dst/build/index.rst:25：(警告/2) autodoc无法导入/查找模块'site_scons.random'，它报告错误：“没有命名为/home/XXX/YYYYY/development/dst/build/index.rst:25:的模块”，请检查您的拼写和sys.path
浏览 2提问于2014-01-09得票数 5
1回答
如何在Jython项目中创建基于Sphinx的文档？
java、python、jython、python-sphinx
我正在做几个使用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
回答已采纳
3回答
生成sphinx文档时无法导入模块
python、python-sphinx
我使用的是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回答
当将文件夹导入为模块时，如何生成Sphynx文档？
python、python-sphinx
我的代码和文档包含以下项目结构：
├───docs
│ ├───_build
│ ├───_static
│ ├───...
│ ├───conf.py
│ ├───index.srt
│ ├───make.bat
| └───Makefile
├───source
│ ├───script1.py
│ ├───script2.py
| └───script3.py
我的conf.py：
import os
import sys
sys.path.insert(0, os.path.abspath('../source'))
...
浏览 3提问于2020-10-05得票数 0
2回答
是否从sphinx autodoc中发出reStructuredText？
python、python-sphinx、autodoc
CPython的文档没有使用autodoc --我们使用的是手写的文章。
对于PEP3144( ipaddress模块)，我想使用sphinx-apidoc来生成初始参考文档。这意味着我想运行一个两遍操作：
使用sphinx-apidoc为依赖于autodoc的模块发出Sphinx项目运行创建新reStructuredText源文件的sphinx构建器，其中所有autodoc指令都替换为内联reStructuredText内容和标记，生成与相同的输出。
第一步很简单，但我不知道如何做第二步，甚至想不出好的方法来搜索任何现有的项目。
浏览 60提问于2012-04-30得票数 22
回答已采纳
1回答
当使用autodoc时，Sphinx找不到Python包
python、python-sphinx、sphinx-apidoc
我正在尝试为测试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
回答已采纳
8回答
如何创建PDF-of-of-Sphinx文档工具
pdf、python-sphinx
点击此链接，尝试从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
2回答
使用Sphinx为每个函数自动生成单独的文档
python、python-sphinx、read-the-docs
我一直在构建一个具有许多不同功能的Python模块。
我使用狮身人面像和readthedocs来提供文档。我已经取得了不错的进步，但目前我有一个，它为我的所有函数提供文档(按字母顺序排列)。
我看过其他项目，每个函数都有一个单独的页面。在查看它们的源代码时，我发现已经为每个源创建了一个单独的.rst文件。我假设这是自动完成的，而在生成autodoc摘要时似乎是在描述其中的一些内容，但我无法理解。
有一个选项(-e)为每个模块创建一个页面，但我希望每个函数都有一个页面。
如何使用Sphinx为每个函数自动生成一个单独的页面？
附加信息
为了为下面的一个答案添加信息，我将以下内容放入位于子目录E
浏览 8提问于2017-04-11得票数 9
回答已采纳
3回答
Python自动摘要:导入模块失败
python、python-sphinx
我正在尝试使用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
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
活动推荐
腾讯云开发者
