Meshroom/docs/README.md

Documentation

We use Sphinx to generate Meshroom's documentation.

Requirements

To install all the requirements for building the documentation, simply run:

pip install sphinx sphinx-rtd-theme myst-parser

You also need to have Graphviz 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:

cd meshroom/docs
make html

To access the documentation, simply go to meshroom/docs/build/html and open index.html in a browser.