toctree

Sphinx Documentation with different separated subjects

假如想象 提交于 2021-01-04 07:16:09
问题 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

Sphinx Documentation with different separated subjects

社会主义新天地 提交于 2021-01-04 07:12:00
问题 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

WARNING: toctree contains reference to nonexisting document error with Sphinx

浪子不回头ぞ 提交于 2020-12-31 11:50:46
问题 I started using Sphinx a couple of days ago to document a python package, and I'm getting what seems to be a common error, but I cannot find a solution for it. I used the sphinx-quickstart to set everything up. I used "doc/" for the documentation root location. The folder containing my package is setup as: myfolder/ doc/ mypackage/ __init__.py moprob.py ... After the quick start, I edited the path in conf.py to be: import os import sys sys.path.insert(0, os.path.abspath('..')) Then I added

WARNING: toctree contains reference to nonexisting document error with Sphinx

折月煮酒 提交于 2020-12-31 11:47:44
问题 I started using Sphinx a couple of days ago to document a python package, and I'm getting what seems to be a common error, but I cannot find a solution for it. I used the sphinx-quickstart to set everything up. I used "doc/" for the documentation root location. The folder containing my package is setup as: myfolder/ doc/ mypackage/ __init__.py moprob.py ... After the quick start, I edited the path in conf.py to be: import os import sys sys.path.insert(0, os.path.abspath('..')) Then I added

How can I link to a page section in a sphinx toctree

試著忘記壹切 提交于 2020-11-28 03:59:35
问题 I have a .. toctree as part of a sphinx page, which includes relative links to other rst files in my package. How can I include a link to a subsection of a given page, rather than the full page itself? I took a stab at .. toctree:: page#section But that didn't work. Any help is great. 回答1: After much hackery, I've come to the following solution, but I should first state that my goal was to: have the heading NOT appear in the content body have the heading appear in the TOC So basically linking

How can I link to a page section in a sphinx toctree

烈酒焚心 提交于 2020-11-28 03:57:04
问题 I have a .. toctree as part of a sphinx page, which includes relative links to other rst files in my package. How can I include a link to a subsection of a given page, rather than the full page itself? I took a stab at .. toctree:: page#section But that didn't work. Any help is great. 回答1: After much hackery, I've come to the following solution, but I should first state that my goal was to: have the heading NOT appear in the content body have the heading appear in the TOC So basically linking