read-the-docs相关内容

在ReadTheDocs上使用自定义主题

我尝试使用从Sphinx的内置ReadTheDocs主题继承的自定义主题。 当我在本地计算机上使用它时，我拥有良好的设计。但当我阅读文档版本(从GitHub导入)时，没有css。 我错过了什么吗？ 使用自定义主题的分支的repo：https://github.com/DigitalSkills-fr/Docs/tree/custom_theme/docs 目标分支的RTD单 ..

发布时间：2022-04-21 23:32:02 python-sphinx read-the-docs 其他开发

如何冻结Sphinx中的第一列和第一行

我是使用Sphinx的新手，我知道Phynx不是注定要用在桌子上的，但我想用它来记录我们的调查工具。因此，我创建了一个表格，其中包含在我们的调查问卷中询问的不同主题。自1984年开始我们的调查以来，我们有很多年的时间可以覆盖。 该表如下： 这些年(行)一直持续到最近一年，而且每年都会增长 当我在Sphnx中使用表格(CSV格式)时，它不会显示整个表格，只显示前几年，然后你必须滚动 ..

发布时间：2022-04-21 21:48:52 css python-sphinx read-the-docs 前端开发

如何强制将文件(MP4)从GitHub传输到ReadtheDocs

我在GitHub上有一个存储库： https://github.com/springer-math/Mathematics-of-Epidemics-on-Networks 其中有一个文件 docs/SIR_2dgrid.mp4 其中包含我希望在Readthedocs的文档中显示的动画(特别是在本页：http://epidemicsonnetworks.readthedoc ..

发布时间：2022-04-21 20:30:16 python-sphinx read-the-docs 其他开发

Sphinx Automodule脱机工作，但不是通过Readthedocs.org

我似乎无法让ReadTheDocs显示Any模块的：Members：，例如，在我的本地html中我获得： MODULE module.Beta(r, theta, beta) evaluates Beta at point 但在推送到GitHub后，ReadtheDocs文档只说： MODULE 未显示任何错误，并且当我在本地将其生成为html时，它运行时没有警告。 ..

发布时间：2022-04-21 19:23:37 python python-sphinx read-the-docs Python

在ReadtheDocs上未呈现Python Sphinx自动文档

我在Github上托管了一个名为spike2py的Python包。我已经使用Sphinx和.rst文件准备了我的文档。这些文件托管在GitHubhere上。我能够在本地成功运行make html并获得所需的输出。也就是说，文档的参考指南部分包含使用我的代码中包含的文档字符串自动生成的API，并通过调用autoclass和autofunction(reference_guide.rst)来引用。 ..

发布时间：2022-04-21 15:56:39 python python-sphinx read-the-docs autodoc Python

如何将徽标添加到我的ReadtheDocs-0px宽的徽标渲染

这是通过运行readthedocs主题的sphinx在本地发生的，它也发生在readthedocs.io中。 我已经添加了一个SVG徽标(实际上它只是从他们的网站复制的下载的RTD logo.svg用于测试)。 我已将设置添加到conf.py，并且html构建正常。 html_theme = 'sphinx_rtd_theme' html_static_path = ['_sta ..

发布时间：2022-04-21 14:28:36 python-sphinx read-the-docs 其他开发

文档字符串不包括在Read the Docs Sphinx版本中

我构建了一个Sphinx文档，该构建在本地运行得很好。我的文档字符串如下所示。 移动到readthedoc.io时，我在docs/requirement.txt下添加了一个特定的需求文件，该文件是： sphinx==3.5.4 sphinx_rtd_theme==0.5.2 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1. ..

发布时间：2022-04-21 13:10:54 python python-sphinx read-the-docs autodoc Python

如何将Read the Docs配置为使用sphinx-audoco-Annotation？

我使用sphinx-autodoc-annotation来读取我的Python代码中的函数注释，并使用它来生成适当的预期参数类型和返回类型。它在我的本地计算机上运行得很好，但我当然必须pip install sphinx-autodoc-annotation。 我正在尝试使用Read the Docs生成相同的文档，但出现错误： Could not import extension s ..

发布时间：2022-04-21 12:04:30 python python-sphinx read-the-docs Python

使用Read the Docs&；Sphinx With ReadTheDocs主题时删除在Github上编辑链接

我正在尝试了解如何使用Sphinx中的_TEMPLATE覆盖选项来覆盖http://readthedocs.org上托管Sphinx文档的默认ReadTheDocs主题。 具体地说，我想删除/隐藏此主题右上角显示的“在Github上编辑”链接。 任何提示都将不胜感激！谢谢！ 我已经查看了此处的文档：http://www.sphinx-doc.org/en/stable/templ ..

发布时间：2022-04-21 11:19:48 python-sphinx read-the-docs 其他开发

在阅读文档侧栏中显示整个目录树

我的理解是新的阅读文档主题generates the sidebar from the toctree，深度为2。我的文档相对深入，深度2是不够的。如何增加或最好完全删除此限制？ 如果这不可能，我如何使用本地目录而不是全局目录树？ 推荐答案 注意：上一个答案已过时。正如@Ariel在一条评论中指出的那样，现在可以通过在html_theme_options中设置navigation ..

发布时间：2022-04-21 09:20:17 python python-sphinx sidebar read-the-docs toctree Python

只阅读文档中的导入链接，而不阅读其中的内容

我对阅读这些文档非常陌生。我的文件夹中有一个文档文件夹Docs 在我的本地机器上使用Sphinx创建的GitHub repo。我尝试将文档链接到阅读文档。 我从Repo的设置添加了Read the Docs服务。 从Read the Docs网站导入项目。 但是，Read the Docs中的文档仅显示了index.html文件的首页。当我点击任何链接时，所有链接都是空的。然而， ..

发布时间：2022-04-20 23:00:58 python python-sphinx read-the-docs Python

我在Read the Docs上的项目建设上遇到了问题

使用sphinx-ickStart创建了狮身人面像项目。已运行html"；且未产生任何错误。已将所有代码推送到GitHub。我试图在Read the Docs上导入和构建项目，但得到了以下错误。我在使用Mac时没有问题--它会在Read the Docs上构建并呈现代码。这一次我使用的是Windows 10。 Traceback (most recent call last): ..

发布时间：2022-04-20 22:19:45 python-sphinx read-the-docs 其他开发

如何在制作htmlHelp时使用Sphinx RTD主题隐藏侧边栏

将Sphinx与ReadTheDocs主题一起使用时是否可以隐藏侧边栏？ 将问题再扩展一下，我可以在发出命令时将其包括在侧边栏中吗： $make html 并且不包括它发出命令： $make htmlHelp 而不更改代码？也许可以在layout.html中添加一些内容。 推荐答案 首先，在一个帖子中问两个问题是不好的形式。下次，创建单独的问题。 对 ..

发布时间：2022-04-20 22:14:32 python python-sphinx read-the-docs Python

如何定制Sphinx RTD主题默认搜索设置？

如何覆盖Sphinx RTD主题附带的默认搜索html。我使用的是Sphinx 1.5，主题总是导入的，而不是静态的。 推荐答案 请参阅Sphinx文档中的Templating。 要自定义文档的输出，您可以覆盖所有模板(布局模板和子模板)，方法是将与原始文件名相同的文件添加到Sphinx QuickStart为您生成的结构的模板目录中。 Sphinx将首先在TEMPLATE ..

发布时间：2022-04-20 20:41:13 python-sphinx read-the-docs 其他开发

使用Sphinx为每个函数自动生成单独的文档

我一直在构建具有许多不同函数的Python模块。 我使用Sphinx和Readthedocs来提供文档。我已经取得了不错的进展，但目前我有one massive page，它提供了我所有功能的文档(按字母顺序)。 我看过其他项目，每个功能都有单独的页面。在查看它们的源代码时，我发现每个都创建了一个单独的.rst文件。我假设这是自动完成的，并且this page在生成自动文档摘要时似乎描 ..

发布时间：2022-04-20 19:58:27 python python-sphinx read-the-docs Python

使用GitHub操作发布文档

我考虑的： GitHub提供GitHub页面来托管master分支或专用gh-pages分支上的文档，但这意味着提交构建构件 我还可以让readthedocs通过WebHook为我构建和托管文档，但这意味着学习如何在尝试整合github-actions中与我的项目相关的所有内容的时间点配置另一个工具 我已经有了一个适合我的文档构建过程(使用sphinx作为构建器)，并且我还可以在本地 ..

发布时间：2022-04-06 23:08:43 python-sphinx github-pages read-the-docs github-actions 其他开发

python的sphinx autodoc没有显示任何内容(在readthedocs上)

我有 这个 python 包，我想使用 Sphinx 自动记录它.我已经在每个函数和类中插入了文档字符串. 我在 ReadTheDocs 上注册了一个帐户，并进行了相应的设置(即，一个带有 conf.py 文件的 docs/ 目录).然后，基本上，我几乎尝试了所有方法:autodoc::、autofunction::、autoclass:: 的每种组合；我尝试使用 same conf.py ..

发布时间：2021-11-15 03:42:26 python api python-sphinx read-the-docs autodoc Python

python的sphinx autodoc没有显示任何内容(在readthedocs上)

我有 这个 python 包，我想使用 Sphinx 自动记录它.我已经在每个函数和类中插入了文档字符串. 我在 ReadTheDocs 上注册了一个帐户，并进行了相应的设置(即，一个带有 conf.py 文件的 docs/ 目录).然后，基本上，我几乎尝试了所有方法:autodoc::、autofunction::、autoclass:: 的每种组合；我尝试使用 same conf.py ..

发布时间：2021-11-15 03:37:21 python api python-sphinx read-the-docs autodoc Python

Sphinx 运行时如何预处理源文件?

我已经为我的项目设置了一个 Sphinx 文档，并且想要提取源文件的文档字符串并将它们嵌入到最终文档中.不幸的是，Sphinx 不支持源文件的语言 (VHDL).VHDL 似乎没有 Sphinx 域. 所以我的想法如下: 挂钩 Sphinx 运行并在 Sphinx 之前执行一些 Python 代码 Python 代码从每个源文件(最顶层的多行注释块)中提取文本块，并为每个源文件组装一 ..

发布时间：2021-09-17 19:48:59 python python-3.x vhdl python-sphinx read-the-docs Python

readthedocs 和 setuptools scm 版本错误

我刚刚更新了一个包以使用 setuptools_scm，发现 readthedocs 中的版本号错误. http://sshuttle.readthedocs.org/en/v0.77/ 显示: 版本:0.78.dev0+ng083293e.d20160304 然而由于版本 083293e 有 0.77 标签，版本字符串应该只是 0.77 看起来 readthedocs 可能在构建 ..

发布时间：2021-07-23 19:39:21 setuptools read-the-docs setuptools-scm 其他开发