blob: 6680e8c84b6c9f5b44f53cfcc25b7e99fa980da3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
# Documentation
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
make html
```
To access the documentation, simply go to `meshroom/docs/build/html` and open `index.html` in a browser.
|
