现在在folder A中，我这样做了要生成配置文件，例如A\documentation\A.math.rst然后在A\documentation中，我使用make html。如果导入路径中没有根目录，如何使sphinx-apidoc生成配置文件？
浏览 6提问于2016-12-26得票数 0
回答已采纳
2回答
由于库目录结构相当大，我希望Sphinx将.rst文件作为一个嵌套目录生成，该目录反映包和模块结构。 │ ├── Hash.py│ │ └── __init__.py└── locker.py
到目前为止，我一直在使用sphinx-apidoc -e -o ...在docs/source/文件夹中生成文档。
浏览 15提问于2020-11-03得票数 1
回答已采纳
4回答
我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我在指示Sphinx递归扫描我的文件时遇到了困难。workspace>中运行了sphinx-quickstart，所以现在我的结构如下所示：├── src│ ├── __init假定我将为代码库中的每个模块/类/函数手动创建文档文件。我修改了我的conf.py以将我的src文件夹添加到sys.path</e
浏览 5提问于2011-01-06得票数 54
回答已采纳
项目中的每个文件都包含大量文档。有没有办法快速地将我的整个项目添加到文档索引中？.. automodule:: mymodulename所做的一切似乎都是在__init__.py文件中记录元素(只是一个文档字符串我希望添加我的包中定义的所有内容，并将包中的每个类、常量、函数(等)添加到适当的索引中。
这可以做到吗？
浏览 2提问于2012-01-10得票数 13
回答已采纳
使用sphinx，我如何让我的git仓库根目录中的README.rst包含在我的sphinx文档中的index.rst中？我正在使用apidoc和autodoc。
浏览 1提问于2015-01-28得票数 2
我有一个项目，它只包含pytest测试，不包含测试远程项目的模块或类。response.status_code == 200可以使用Sphinx
浏览 4提问于2019-11-15得票数 1
3回答
我正在使用Sphinx为具有如下结构的项目生成文档：|||exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow
浏览 5提问于2017-05-05得票数 15
回答已采纳
我正在尝试使用Sphinx来记录我一直在使用的Python库。我一直在使用作为一个粗略的指南。但是，我很难让狮身人面像正常工作。一旦所有设置就绪，Sphinx就已经安装好了，并且我在我的代码中添加了从我的项目根目录中输入的文档：输出：
Creating接下来，我分别编辑docs/conf.py . my，确保我的
浏览 7提问于2013-12-28得票数 2
回答已采纳
1回答
我正在尝试使用sphinx来为我的项目创建一个文档，它是一堆划分为项目内部模块的函数。我只需要在文档中公开一小部分函数，所以我使用autodoc-skip-member通过标记文档字符串来过滤掉不需要的函数，它似乎没有列出不需要的函数，但我最终得到了一堆空模块和子模块。有没有办法告诉sphinx不要列出空的模块？我假设我可以使用exclude特性，但是添加新代码的过程将不会是自动化的，我将不得不一直维护排除列表。我使用这个流来生成HTML文档：
sphinx-apidoc -f -e -M -o sour
浏览 5提问于2020-12-06得票数 2
1回答
我在一个包含rst的automodule文件上运行狮身人面像，但它似乎没有任何效果。agent module :undoc-members:
:show
浏览 4提问于2020-01-24得票数 6
回答已采纳
我们不想维护文档和源代码，因为源代码目前正在快速发展，但是Sphinx似乎需要大量令人沮丧的设置和配置。(我们只需要一些基本的API文档。)难道没有一个命令可以在python项目中运行，它只会迭代生成HTML文档的所有包、模块、类和函数吗？sphinx将内容拆分到一个目录中，在修改conf.py使我们的包在sys.path中后，我们可以运行"make“，但它只列出包和模块，而不记录任何类或函数。
谢谢!
浏览 8提问于2013-02-26得票数 16
我在一个名为foo.py的包中有一个模块mypackage """foo some bars
--------"和一个foo.rst文件：==============
:members:
浏览 17提问于2022-05-28得票数 1
我知道下面的代码为所有模块生成rst，但不包括index.rst下面的代码生成所有内容，包括index.rst、conf.py、Makefile等问题是sphinx-apidoc不能生成正确的conf.py，所以我必须总是手动修改conf.py以包含正确的sy
浏览 4提问于2014-02-18得票数 2
当我运行sphinx-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？下面是我想要制作的一个文档页面示例(注意TOC)：
我可以手动编辑每个单独的.rst文件来删除这些标题，或者只
浏览 2提问于2014-01-08得票数 18
回答已采纳
所以我有一个Python应用程序，我正在尝试用Sphinx编写文档。我已经创建了目录结构，运行了sphinx-quickstart和sphinx-apidoc，并将我的config.py更改为：No module named &#x
浏览 12提问于2021-05-18得票数 0
回答已采纳
2回答
我试图使用sphinx (与autodoc和numpydoc一起)来记录我的模块，但是在基本设置之后，运行make html只生成基本的html，而文档字符串中没有任何内容。|--kineticmulti| | |--file1.py|--setup.py
__init__.py为空，在conf.py中，在docs/source目录中，我添加了sys.path</em
浏览 3提问于2014-07-23得票数 6
回答已采纳
运行sphinx-apidoc后，命令C:\path\to\doc\make html将产生一个错误开始：
1-尝试运行sphinx_apidoc
'C:\path\to\jython\bin\sphinx-apidoc‘不被认为是内部或外部命令。2-使用Jython调用:带有合理选项的jython C:\path\t
浏览 3提问于2014-02-03得票数 1
回答已采纳
在用sphinx-apidoc.生成RST文件时，无法正确添加__main__.py文件及其函数其他文件和类是正确生成的。 main() description here f1() main()
我希望在sphinx生成的R
浏览 0提问于2019-01-11得票数 1
回答已采纳
我想指定一个GitLab作业来创建一个sphinx文档。pages: tags: script: - sphinx-build -b html docs/ public/ - master
然而，管道失败了：sphinx-build:
浏览 2提问于2020-04-09得票数 2
回答已采纳
我们使用Sphinx来格式化Python文档，使用cement来配置CLI。不幸的是，Sphinx会从cement配置中生成大量无意义的输出。我找不到任何Sphinx指令或命令行选项来忽略不应该格式化的水泥配置。我们使用的是Sphinx 2.2.0和带有选项-f -P -o的sphinx-apidoc。例如，Sphinx对此Python进行格式化 """
浏览 1提问于2019-09-10得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
云直播活动推荐
腾讯云开发者
