1回答
当我构建我的文档时，html文档的左侧菜单类似于： main_package |-- Subpackages | |-- subpackage_2 |-- Submodules |-- Module contents 如何在此菜单中添加子模块列表？
浏览 8提问于2020-09-16得票数 0
回答已采纳
当我运行sphinx-apidoc，然后运行make html时，它会在目录(TOC)中的每个模块/包名称的末尾生成“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑Sphinx源代码的情况下，如何防止编写这些额外的标题？下面是我想要制作的一个文档页面示例(注意TOC)：
据我所知，这是由于sp
浏览 2提问于2014-01-08得票数 18
回答已采纳
Test2(): """fn_test2 """这些类存储在不同的文件夹中，但是它只使用以下命令找到了Test1.rst：
$ sphinx-apidoc -f -A "Author" -H "Test project" -V "v
浏览 1提问于2014-09-05得票数 3
然而，我得到的结果是：有人知道我是否可以自定义sphinx-api用于其输出的模板？具体来说，我想：
让我的__init__.py文件中的docstring的结果直接出现在包下面，所以如果我单击包名，我首先看到的是包文档。目前，该文档放在每个包部分末尾的“
浏览 9提问于2015-04-01得票数 18
回答已采纳
有什么方法可以排除模块的导入部分，然后用sphinx记录它吗？我有一个模块，它导入了另一个包(其他不同的项目)，然后斯芬克斯给出了这个错误：
“File "/usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7/mod_example1.py"，第33行，在other_pck import中，KlassStuff Imp
浏览 5提问于2013-02-26得票数 4
回答已采纳
我有一个python包，即将从epydoc迁移到sphinx。这个包本身包含了sphinx的automodule函数。现在，我希望在我的文档模块开头的一个简单列表/表中列出模块中所有类的摘要，或者更好(？)在toc-tree中。我的自动模块部分(在pymunk.rst中)如下所示 :members:
浏览 3提问于2012-08-28得票数 6
回答已采纳
4回答
我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我在指示Sphinx递归扫描我的文件时遇到了困难。，Sphinx假定我将为代码库中的每个模块/类/函数手动创建文档文件。我修改了我的conf.py以将我的src文件夹添加到sys.path中，然后修改了我的index.rst以使用自动模块。* :ref:`genindex`* :r
浏览 5提问于2011-01-06得票数 54
回答已采纳
我正在尝试使用可读性模块，但是出现了下面的错误。我怎样才能使用“可读性”？/usr/local/opt/python/bin/python3.6: No module named readability.readability
我执行的命令如下所示。
浏览 0提问于2018-04-11得票数 0
我有一个python包，并且我能够使用以下命令从python代码自动创建sphinx文档make html这可以很好地工作，并且html列出了所有子模块及其文档。每个模块都有自己的文档，但是如何将tom文档文本直接放在包名下面呢？我想要有以下结构： General package documentation...如何通过只更改python<
浏览 0提问于2013-11-12得票数 6
我下载了'sphinxcontrib.httpdomain‘包并放入Sphinx-1.2目录：我在扩展项下修改了conf.py“让干净的html”失败了：
扩展错误:无法导入扩展sphinx.sphinxcontr
浏览 2提问于2014-01-16得票数 2
1回答
我正在使用Sphinx为存储库生成文档。Sphinx toctree允许使用:glob:自动选择某些文档。我有一个表格的toctree :maxdepth: 1其中第一个*获取位于/some/repository/structure中的所有不同模
浏览 1提问于2018-02-01得票数 1
2回答
我正试图为我的图书馆生成文档。由于库目录结构相当大，我希望Sphinx将.rst文件作为一个嵌套目录生成，该目录反映包和模块结构。 ├── Hash.py│ │ └── __init__.py└── locker.py预期成果：
作为嵌套目录生成的文档。文件已被移除，以便仅保留主干。source/
浏览 15提问于2020-11-03得票数 1
回答已采纳
我需要Sphinx自动摘要扩展来使用:toctree: generated/生成存根，但我也想防止目录条目出现在HTML侧边栏中。autosummary成功地为这些subsubpackages中的所有类和函数生成了存根文件，但不为中间包生成存根.rst文件。最后，我留下了缺少的存根文件，没有存根文件，子子包的类和方法既不存在TOC条目，也不存在模块路径。使用Sphinx的.. toctre
浏览 76提问于2021-06-26得票数 0
1回答
在有关sphinx扩展的文档中，有一些“配置值”。例如在中。
但我不知道如何设置这些价值观。它是我必须设置的shell上的参数吗？
浏览 6提问于2022-03-03得票数 0
回答已采纳
我正在使用Sphinx来记录我的Python包。当我在我的模块上使用自动模块指令时：:members:
它打印文档字符串中的所有内容，包括GPL通知。有没有办法告诉Sphinx忽略docstring/GPL，或者我应该把它包含在文档中？
浏览 0提问于2013-06-20得票数 8
回答已采纳
我在一个大型存储库中工作，其中包含大约100个单独的文件夹，每个文件夹都有20-30个子文件夹，每个子文件夹都包含自己的.py文件夹。目前，我必须使用sphinx-apidoc命令为每个文件创建.rst文件，然后将路径添加到conf.py文件，然后将.rst文件添加到index.rst文件。有没有一些自动化的方法，这样只需要几个命令就可以完成所有这些工作。
浏览 13提问于2019-03-03得票数 1
回答已采纳
在用sphinx-apidoc.生成RST文件时，无法正确添加__main__.py文件及其函数其他文件和类是正确生成的。def main(): main() description here
"
浏览 0提问于2019-01-11得票数 1
回答已采纳
1回答
我想从嵌套文件夹结构中的脚本中生成sphinx autodoc文档： └── general_name ├── script1.py我正在运行这个命令：我也试过：
$ sphinx-ap
浏览 1提问于2018-01-21得票数 4
2回答
在根目录中导入Java包
、、、
我在一个子域subdomain.site.com中，在/usr/share/sphinx/api/java的根目录中有一个更高层的java包。要导入这个包，典型的做法是编写然而，当我这样做时，我得到了一个包不存在的错误。
这个问题的解决方案是什么？某种路径定义？( Linux CentOS上的
浏览 3提问于2011-06-16得票数 0
回答已采纳
我们使用Sphinx来生成Python文档。这是我们使用的命令行：问题是我们每个包只有一个页面。然而，我们真正需要的是每个模块一个页面，否则页面会变得太长。
我该怎么设置呢？
浏览 0提问于2012-07-25得票数 12
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
云直播活动推荐
腾讯云开发者
