diff options
author | Loïc Vital <mugulmotion@gmail.com> | 2022-10-14 13:51:50 +0300 |
---|---|---|
committer | Loïc Vital <mugulmotion@gmail.com> | 2022-10-14 15:41:07 +0300 |
commit | 07e993a3ebf54dc16fcd6bed04d1d83d443ceea5 (patch) | |
tree | ebcee754db99a73f9e3cea2cfd008e21948ab3d0 /docs | |
parent | 652113443d79e95ac85db2c168cf5a372a66f179 (diff) |
[docs] inheritance diagram
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 6 | ||||
-rw-r--r-- | docs/source/_templates/autosummary/class.rst | 3 | ||||
-rw-r--r-- | docs/source/conf.py | 4 |
3 files changed, 12 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index 303059dc..6680e8c8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst index 03dc3878..958658a3 100644 --- a/docs/source/_templates/autosummary/class.rst +++ b/docs/source/_templates/autosummary/class.rst @@ -1,6 +1,9 @@ {{ fullname | escape | underline}} +.. inheritance-diagram:: {{ fullname }} + + .. meshroom_doc:: :module: {{ module }} :class: {{ objname }} diff --git a/docs/source/conf.py b/docs/source/conf.py index 6f58c912..33c201d9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'] |