3pp-mirror/Meshroom
1
0
Fork 0
mirror of https://github.com/alicevision/Meshroom.git synced 2025-04-28 17:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity
Meshroom/docs
History
Candice Bentéjac 8bef398bed Remove workarounds and backports for Python 2 support 
In particular:
- In common/, remove the backport of weakref.WeakMethod
- In docs/ and ui/, use the standard FileNotFoundError class
- Use built-in open() instead of io.open(), and stop importing io
- In core/stats.py, use the standard implementation of xml.etree instead
of the C one
2022-12-05 17:16:21 +01:00
..
logo update meshroom logo, icon and banner 2018-04-21 11:56:22 +02:00
source Remove workarounds and backports for Python 2 support 2022-12-05 17:16:21 +01:00
.gitignore [doc] sphinx documentation setup 2022-10-11 09:59:33 +02:00
make.bat [doc] sphinx documentation setup 2022-10-11 09:59:33 +02:00
Makefile [doc] sphinx documentation setup 2022-10-11 09:59:33 +02:00
README.md [docs] inheritance diagram 2022-10-14 14:41:07 +02:00
requirements.txt [docs] readthedocs setup 2022-10-21 11:36:40 +02:00

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.