[docs] inheritance diagram

This commit is contained in:
Loïc Vital 2022-10-14 12:51:50 +02:00
parent 652113443d
commit 07e993a3eb
3 changed files with 12 additions and 1 deletions

View file

@ -2,13 +2,19 @@
We use [Sphinx](https://www.sphinx-doc.org) to generate Meshroom's documentation.
## Requirements
To install all the requirements for building the documentation, simply run:
```bash
pip install sphinx sphinx-rtd-theme myst-parser
```
You also need to have [Graphviz](https://graphviz.org/) installed.
> Note: since Sphinx will import the entire `meshroom` package, all requirements for Meshroom must also be installed
## Build
To generate the documentation, go to the `docs` folder and run the Sphinx makefile:
```bash
cd meshroom/docs

View file

@ -1,6 +1,9 @@
{{ fullname | escape | underline}}
.. inheritance-diagram:: {{ fullname }}
.. meshroom_doc::
:module: {{ module }}
:class: {{ objname }}

View file

@ -26,7 +26,9 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'fetch_md',
'meshroom_doc'
'meshroom_doc',
'sphinx.ext.graphviz',
'sphinx.ext.inheritance_diagram'
]
templates_path = ['_templates']