sphinx/autodoc toc未列出子弹
我有以下结构的小存储库: |- doc/ |- conf.py |- index.rst |- ... |- src/dashtutorial/ |- __init__.py |- data/ | |- __init__.py | |- types.py …
如何在狮身人面像中使用AutoDOC显示Docstrings?
如何配置项目,因此它将使用sphinx autodoc从Python代码获取Docstring并在HTML上显示? 从文档中尚不清楚要添加在哪里可以使AutoDoc获取我所有的docst…
带有狮身人面像的Robotframework文档
我在为狮身人面像的Robotframework资源创建自动文档时有很小的问题。 我找到了两个插件: sphinxcontrib_robotdoc , sphinxcontrib_robotframework …
如何解决错误&quot“警告:test命令发现但未安装在testenv”中。为毒品?
使用托克斯3.7.0-2我会出现错误 WARNING: test command found but not installed in testenv cmd: /usr/bin/make env: /builds/common/doc/docs-creat…
参考文章或角色在斜体中是否起作用?
我想添加一个:ref:在斜体字中。 因此,我写了*另请参见:: ref:`a-page`:ref:`'other-page`*。 该行的斜体可以完全正确,但是Refs的链接不会产…
用sphinx_book_theme构建sphinx
我正在尝试将sphinx与 sphinx beam theme 在我的文档中构建文档的问题。 设置 我安装了sphinx和主题的 pip install sphinx pip install sphinx_book_t…
如何访问``conf.py''中的“ sphinx -build -t abc”之类的标签?
根据sphinx的文档, tags 对象在 conf.py ( master )。但是,我得到: attributeError:'nontype'对象没有属性'有' conf.py : if tags.has('abc'):…
rinohtype phinx自定义PDF中的样式
我正在使用 rinohtype 用于将我的rst文件生成pdf。 我试图了解如何在PDF中为我的徽标和其他元素提供自定义样式。 我以某种方式感受到 default norefer…
我如何从Markdown中生成文档,并使用双括号引用到其他Markdown [黑曜石,Sphinx]?
我在版本控制中有一个黑曜石保险库,其中包含大量项目的文档。这些文档具有对其他文档的双括号引用,例如: 有关更多信息,请参见[[Roadmap.md]]。 我…
如何覆盖Seealso :: Directive in Sphinx中的指示?
我正在项目中使用sphinx,我想更改'另请参阅标题 seealso :: 在模板中的框。 我还在代码中搜索了一点,并在狮身人面表库中看到了Seealso类,但我不知…
在__init __.py中导入的狮身人面像隐藏模块
我的软件包具有类似于以下内容的结构: ├── README.md ├── __init__.py ├── module1 │ └── submodule1.py │ └── submodule2.py ├─…
如何在Sphinx主题或扩展构建事件中设置配置值?
我正在构建一个子类主题,该主题是另一个主题,并在sphinx中设置了几个默认配置值(例如, html_theme_options 的值的子集)。 我尝试编写回调事件函…
狮身人面像包括私人属性,即使没有指示
我没有在任何地方包括:private-Members:选项,但是Sphinx仍然在课堂文档中包含私人属性。我在做什么错? MWE: mypackage/foo.py : class MyClass(…