我可以从Jupyter笔记本电脑中引用Sphinx中的一个部分吗?
我在文档目录的顶部有自动化的API文档,并且在笔记本 subdirectory中的笔记本中有这样的笔记本: /src /mypkg -- modname.py /docs -- index.rst # in…
狮身人面像:记录python库的入口点(控制台脚本)
我正在开发一个小的Python 3.10库。我已经集成了Sphinx 5.0来记录项目功能,类,模块等。这在Ubuntu容器上运行。文档正在起作用。让我感到困惑的观点…
如何在字面字符串中缩进文字?
我想通过划线,然后是缩进的字面输出,以使结果看起来像这样: int write(const std::string sFileName, int iStep, float fStartTime, const std::st…
为什么某些Fontawesome图标不会在HTML中呈现?
我正在尝试添加一些 fontawesome 图标 iCONS iCONS添加到html文档中,该文档呈现为> > html html 来自 rst 。有些图标是渲染的,有些不是。 这是 inde…
在Sphinx中的模块页面顶部生成功能列表
我觉得这应该很简单,但是经过数小时的实验/搜索,我没有任何地方。 我在一个称为 mypackage 的软件包中有一个模块 foo.py : def foo1(bar1, bar2): …
如何让双折叠产生的sphinx PDF文本类似于HTML的输出(带有框架的红色文本)?
在我的重组文本文档中,使用双折叠的文本周围的双折,这会导致HTML输出以红色显示文本,并带有周围的框架。我想让我的latexpdf输出看起来相同。 PDF以…
sphinx-js可以查找类文档
我正在尝试设置sphinx_js,但我一直收到此错误: ~/test_sphinx_js$ sphinx-build -b html docs/source/ docs/build/html/ Running Sphinx v4.4.0 bui…
无法更改sphinx_rtd_theme侧边栏的文本颜色
我正在尝试自定义使用sphinx_rtd_theme创建的文档。默认主题具有背景颜色黑色和文本颜色白色的侧边栏。我已经成功地将侧边栏的背景颜色从使用黑色的白…
警告:autodoc:无法导入模块' upload_data_to_server'来自模块'手册';
我正在尝试使用Sphinx的AutoDoc扩展名来记录Django项目。我有两个主要问题: 它记录了一些模块中的多余问题(我不想从django导入文档), 它根本没有…
我可以使用sphinx.ext.viewcode显示行号吗?
我正在使用 sphinx.ext.viewcode 记录我的API。是否可以在生产的Cod-Block上显示线号,如果是的话? 我试图在文档中找到 html_option ,但没有找到任…
显示Sphinx Autodoc中继承属性的DocString
我有两个类,一个基类和一个从此基类继承的类 from abc import ABC class Base(ABC): """ Base class Parameters ---------- param1 : int Attributes…
如何使用sphinx v4.5.0使用线号来修复事故格式?
最初,我在Sphinx v3.5.4中的代码很好。我使用了以下代码。 .. code-block:: python :caption: ex2.py: step 3 :name: ex2.py :linenos: :lineno-star…
在Python3-Sphinx中显示带有网格的数据
我构建了Python3-Sphinx来存储并显示一些材料。 vim show_table.rst show table ================= | # | Expression | Result | Comments | | --- | …