read-the-docs

问题 I have a Python project using Sphinx for docs. I am building the docs remotely on readthedocs.io service. I used sphinx-quickstart and it generated an index.rst file with these links in the footer: Indices and tables ~~~~~~~~~~~~~~~~~~ * :ref:`genindex` * :ref:`modindex` * :ref:`search` When I push changes to readthedocs.io and build the docs, my build succeeds. Docs that I manually linked via toctree directive all work fine. The search link works fine. But the genindex link goes to an empty

问题 I have a local readthedocs install and get a ValueError exception when trying to import a project. I'm on release 5.1.0, running python 3.6 on Debian buster with celery 4.1.1 (from the requirements files). From the debug.log: [19/May/2020 23:31:11] celery.app.trace:124[24]: INFO Task readthedocs.projects.tasks.send_notifications[39551573-cfe1-46c1-b7e2-28bde20fd962] succeeded in 0.005342413205653429s: None [19/May/2020 23:31:11] celery.app.trace:124[24]: INFO Task readthedocs.oauth.tasks

问题 I follow the instructions on read the docs but I get this error: bash Sphinx error: master file /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst not found Do have to you the read the docs yaml file? 回答1: If you have your own conf.py file, it overrides Read the Doc's default conf.py . By default, Sphinx expects the master doc to be contents . Read the Docs will set master doc to index instead (or whatever it is you have specified in your

问题 I follow the instructions on read the docs but I get this error: bash Sphinx error: master file /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst not found Do have to you the read the docs yaml file? 回答1: If you have your own conf.py file, it overrides Read the Doc's default conf.py . By default, Sphinx expects the master doc to be contents . Read the Docs will set master doc to index instead (or whatever it is you have specified in your

问题 I'm trying to set up a sphinx documentation and put it online using ReadTheDocs, however following the steps of the tutorial I end up by having the following error pop in my build: Read the Docs build information Build id: 12647743 Project: documentationseries Version: latest Commit: None Date: 2020-12-28T11:42:02.102474Z State: finished Success: False [rtd-command-info] start-time: 2020-12-28T11:43:48.024647Z, end-time: 2020-12-28T11:43:48.412733Z, duration: 0, exit-code: 0 git clone --no

问题 I'm trying to set up a sphinx documentation and put it online using ReadTheDocs, however following the steps of the tutorial I end up by having the following error pop in my build: Read the Docs build information Build id: 12647743 Project: documentationseries Version: latest Commit: None Date: 2020-12-28T11:42:02.102474Z State: finished Success: False [rtd-command-info] start-time: 2020-12-28T11:43:48.024647Z, end-time: 2020-12-28T11:43:48.412733Z, duration: 0, exit-code: 0 git clone --no

问题 I'm trying to build kind of a dashboard in the index with one tile per subject. Each subject will later have its own folder in source with it's own md files. I want each subject to be disconnected to the others. So the previous button should no go to another subject. The structure should be something like this: First there is an overview with all subjects, then there is a subpage with one toctree per subject and then each document has its own normal view. Does anyone have an idea how I would

问题 I'm trying to build kind of a dashboard in the index with one tile per subject. Each subject will later have its own folder in source with it's own md files. I want each subject to be disconnected to the others. So the previous button should no go to another subject. The structure should be something like this: First there is an overview with all subjects, then there is a subpage with one toctree per subject and then each document has its own normal view. Does anyone have an idea how I would

来源： https://stackoverflow.com/questions/37553750/how-can-i-link-reference-another-rest-file-in-the-documentation

来源： https://stackoverflow.com/questions/40556423/how-can-i-link-the-generated-index-page-in-readthedocs-navigation-bar