我完全不知道如何在reST文件中链接到另一个文档。 我想要在快速入门指南的一个段落中链接一个名为install.rst的文件,但不知道应该怎么做。 请您还可以提供一个伟大的资源,让我可以查找rest语法。默认的快速入门指南有点无聊,没有涉及使用sphinx的深度讨论。 相关的文档是:ht...
我按照read the docs上的指示操作,但是出现了以下错误: bash Sphinx错误: master文件 /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/so...
我完全不了解这个领域,花了一整天时间试图弄清楚“最常用”的方法。我想实现的是类似于readthedocs.org的东西,但针对私有客户(且为专有项目)。 几乎所有的FAQ、博客文章、how-to等都描述了如何使用GitHub页面或readthedocs.org(.com)发布文档。 我尝试...
我已经使用自定义 CSS 来覆盖主题的某些样式,方法是def setup(app): app.add_css_file('custom.css') 这个运作得很好。还有哪些应用功能可用?我找不到任何文档。 我在寻找覆盖网站图标的功能。
我正在为我的API库构建文档,并使用readthedocs.io托管文档,后台使用Sphinx。我已经使用pip install 安装了Sphinx的Read The Docs主题,并且目前已经在Read the Docs网站上运行了文档。 我想更改文档的颜色。我在他们的GitHub存储库Gi...
当使用 sphinx-rtd-theme 时,我希望在侧边栏中有一个链接指向自动生成的索引。我已经尝试将其添加到 toctree 中:.. toctree:: first second Index <:ref:`genindex`> 但这导致了WARNIN...
在read-the-docs平台上构建Sphinx文档失败,报以下错误(完整日志见下):ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readth...
问题 当我在readthedocs.io网站界面上点击“构建”时,我的文档无法成功构建,但在我的本地计算机上构建非常顺利。为了测试这是否是一个环境问题,我创建了一个虚拟环境: conda create virtualenv -n venv conda env export -n venv ...
我想在reStructuredText文档中使用iframe来嵌入一个交互式图形,该图形保存为html文件:.. raw:: html <iframe src="filename.html" height="345px" width="100%"></iframe&...
我一直在尝试使用readthedocs.org提供的主题,在Github页面上发布我们仓库的Sphinx生成文档。 经过几次尝试,我成功通过将Sphinx生成的HTML文件上传到仓库的gh-pages分支来使其上线。 得到如下结果: https://takeqontrol.github....