python-sphinx

问题 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've got something like this: .. toctree:: :maxdepth: 2 :caption: Contents: :hidden: :glob: docs frontend backend tools/* I'd like all the documents found in the tools directory to collapse into one expandable sidebar TOC entry. Should be possible, but I can't find a clue. I use sphinx_rtd_theme . To put it another way: suppose I have a very long document like this ( tools.rst ): Section 1 ********* Subsection 1 ============ Subsection 2 ============ Subsection 3 ============ How am I

问题 I've got something like this: .. toctree:: :maxdepth: 2 :caption: Contents: :hidden: :glob: docs frontend backend tools/* I'd like all the documents found in the tools directory to collapse into one expandable sidebar TOC entry. Should be possible, but I can't find a clue. I use sphinx_rtd_theme . To put it another way: suppose I have a very long document like this ( tools.rst ): Section 1 ********* Subsection 1 ============ Subsection 2 ============ Subsection 3 ============ How am I

问题 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

问题 Using the Sphinx "TODO" Directive example I would like to reference the todo instances embedded within a .rst file. For example, if the .rst file content contains: .. todo:: foo .. todo:: bar I can see that the following code (taken from the Sphinx TODO example page) class TodoDirective(SphinxDirective): # this enables content in the directive has_content = True def run(self): targetid = 'todo-%d' % self.env.new_serialno('todo') targetnode = nodes.target('', '', ids=[targetid]) todo_node =

问题 Using the Sphinx "TODO" Directive example I would like to reference the todo instances embedded within a .rst file. For example, if the .rst file content contains: .. todo:: foo .. todo:: bar I can see that the following code (taken from the Sphinx TODO example page) class TodoDirective(SphinxDirective): # this enables content in the directive has_content = True def run(self): targetid = 'todo-%d' % self.env.new_serialno('todo') targetnode = nodes.target('', '', ids=[targetid]) todo_node =

问题 Using the Sphinx "TODO" Directive example I would like to reference the todo instances embedded within a .rst file. For example, if the .rst file content contains: .. todo:: foo .. todo:: bar I can see that the following code (taken from the Sphinx TODO example page) class TodoDirective(SphinxDirective): # this enables content in the directive has_content = True def run(self): targetid = 'todo-%d' % self.env.new_serialno('todo') targetnode = nodes.target('', '', ids=[targetid]) todo_node =

问题 Using the Sphinx "TODO" Directive example I would like to reference the todo instances embedded within a .rst file. For example, if the .rst file content contains: .. todo:: foo .. todo:: bar I can see that the following code (taken from the Sphinx TODO example page) class TodoDirective(SphinxDirective): # this enables content in the directive has_content = True def run(self): targetid = 'todo-%d' % self.env.new_serialno('todo') targetnode = nodes.target('', '', ids=[targetid]) todo_node =

问题 I have a project with the following structure (which I would like to keep): my_project ├── build # here is where sphinx should dump into ├── requirements.txt ├── make.bat ├── Makefile ├── ... # more config files ├── doc # this is where I want sphinx files to live │ ├── conf.py │ └── index.rst ├── src │ └── my_project │ ├── __init__.py │ ├── module_1 │ │ ├── __init__.py │ │ └── ... │ └── util │ ├── __init__.py │ └── ... └── tests ├── module_1 │ ├── __init__.py │ └── ... # testing module 1 └──