mirror of
https://github.com/alicevision/Meshroom.git
synced 2025-04-29 02:08:08 +02:00
18 lines
586 B
Markdown
18 lines
586 B
Markdown
# Documentation
|
|
|
|
We use [Sphinx](https://www.sphinx-doc.org) to generate Meshroom's documentation.
|
|
|
|
To install all the requirements for building the documentation, simply run:
|
|
```bash
|
|
pip install sphinx sphinx-rtd-theme myst-parser
|
|
```
|
|
|
|
> Note: since Sphinx will import the entire `meshroom` package, all requirements for Meshroom must also be installed
|
|
|
|
To generate the documentation, go to the `docs` folder and run the Sphinx makefile:
|
|
```bash
|
|
cd meshroom/docs
|
|
make html
|
|
```
|
|
|
|
To access the documentation, simply go to `meshroom/docs/build/html` and open `index.html` in a browser.
|