标签: read-the-docs

我根本不知道如何链接到reST文件中的另一个文档.

我想install.rst在段落中链接一个名为我的快速入门指南的文件.我不知道如何实现这一目标.

请你也可以参考一个很好的资源,从那里我可以查找语法休息.默认的快速入门有点无聊,并没有涉及使用sphinx休息的深入讨论.

有问题的文件是:http://todx.rtfd.io

在 read-the-docs 上构建 Sphinx 文档失败，并显示以下错误（完整日志如下）：

ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py)

我做错了什么还是这是阅读文档中的错误？

Sphinx 文档的本地构建运行良好。

在 read-the-docs 上完成错误日志：

Read the Docs build information
Build id: 10299638
Project: cascade-python
Version: latest
Commit: a7d50bf781bd8076b10dd7024db4ccb628016c27
Date: 2020-01-21T17:03:12.876711Z
State: finished
Success: False


[rtd-command-info] start-time: 2020-01-21T17:03:13.203354Z, end-time: 2020-01-21T17:03:13.215400Z, duration: 0, exit-code: 0
git remote set-url origin https://github.com/brunorijsman/cascade-python.git


[rtd-command-info] start-time: 2020-01-21T17:03:13.276220Z, end-time: 2020-01-21T17:03:13.630658Z, duration: 0, exit-code: 0
git fetch origin --force --tags --prune --prune-tags --depth 50
From https://github.com/brunorijsman/cascade-python
   2a28505..a7d50bf  master     -> origin/master

[rtd-command-info] start-time: 2020-01-21T17:03:13.824496Z, …

我有一个模块,有两个记录的全球特殊成员.

在本地运行Sphinx会创建包含其文档的文档,但"阅读文档"却没有.它使用内置类型的文档.

我尝试了两种样式:#:和定义后的docstring.我已多次阅读autodoc的文档,并阅读了文档条目.我无法弄清楚我缺少什么,因为我甚至没有看到阅读文档中的任何构建错误.

有任何想法吗？

我有一个使用plot-directive的python-3项目,但ReadTheDocs目前不支持这个项目.因此,我想像通常使用PyPi存储库一样生成和上传文档,但是使用该-r选项指定不同的URL.

我尝试了以下,但它失败了:

$ python3 setup.py build_sphinx register upload_docs -r https://readthedocs.org/pypi
running upload_docs
Using PyPI login from /home/user/.pypirc
Using upload directory /home/user/work/wltp.git/docs/_build/html
Submitting documentation to https://readthedocs.org/wltp/pypi
Upload failed (404): OK

我也尝试了以下网址,但没有任何效果:

• https://readthedocs.org/pypi/wltp
• https://readthedocs.org/pypi/wltp/latest
• https://readthedocs.org/wltp/pypi
• https://readthedocs.org/wltp/latest/pypi/

我正在努力实现(原则上)可能吗？

我希望在使用时能够链接到侧边栏中自动生成的索引sphinx-rtd-theme.我已经尝试将它添加到toctree:

.. toctree::

    first
    second
    Index <:ref:`genindex`>

但这导致了

WARNING: toctree contains reference to nonexisting document u':ref:`geinindex`'

从狮身人面像,没有其他影响.

我想我可以简单地在主题layout.html文件中对索引进行硬编码,但也许有更好的方法,而不是涉及修改标准主题？

TIA任何提示!

我从 Github 下载了 sphinx 的 read-the-docs 主题并将其放入 _themes 文件夹中。

conf.py：

html_theme = "sphinx_rtd_theme"\nhtml_theme_path = ["_themes", ]\n

但是，运行“make html”时出现此错误：

Sphinx v4.1.2 in Verwendung\nLade \xc3\x9cbersetzungen [de]\xe2\x80\xa6erledigt\nloading pickled environment... erledigt\nWARNING: sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0\n\nTheme error:\nno theme named 'sphinx_rtd_theme' found (missing theme.conf?)\n

不知何故，斯芬克斯似乎找到了主题，然后又忽略了它。有人可以告诉我发生了什么事以及如何解决它吗？

我使用Doxygen和Markdown编写了一个中型C++软件的文档.我对它很满意,因为在更改了xml图层之后我得到了类似的内容:http: //docs.mitk.org/nightly/index.html

我想在线提供这些文档,理想情况下使用ReadtheDocs,其中文档将在"git commit"之后自动构建,并托管以进行浏览.

ReadtheDocs看起来像是理想的网站,但使用Sphinx和reStructuredText作为默认值.也可以使用Doxygen,但AFAIK只能通过呼吸.如果我不想将所有API文档转储到单个页面中,那么通过该路由本质上意味着我需要重新构建所有文档(http://librelist.com/browser//breathe/2011/8/6/fwd-guidance-for-usage-breathe-with-existing-doxygen-set-on-a-large-project /#cab3f36b1e4bb2294e2507acad71775f).

矛盾的是,Doxygen安装在read-the-docs服务器上,但在挣扎之后我找不到解决方法来跳过它的Sphinx或Mkdocs.

我正在为我的API库构建文档,而我正在使用readthedocs.io来托管文档,并使用Sphinx支持.我为Sphinx使用安装了Read The Docs主题pip install,而Read the Docs网站目前正在运行文档.

我想改变文档的颜色.我已经通过他们的GitHub存储库GitHub.com进行了一些搜索,并看到了一些关于编辑sass文件的讨论.但是,我似乎无法找到这些文件的位置.

使用其他颜色读取文档的示例

任何帮助表示赞赏!

我想用我自己的自定义样式扩展Sphinx和ReadTheDocs使用的主题.

我能做到这一点的最佳方式是什么,以便我的改变能够坚持下去？

我按照阅读文档中的说明进行操作，但出现此错误：

bash Sphinx错误：未找到主文件/home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst

是否需要阅读docs yaml文件？