This is documentation is work in progress.

See Project ToDo for details.

• capturing images for photogrammetry chapters
• MR2019.2 updates
• improved layout
• readthedocs release (including pdf) https://meshroom-manual.readthedocs.io

• make yourself familiar with ReStructuredText and Sphinx
• do not make any changes to the general structure (yet)
• open an Issue for questions

We could use some help with:

• optimizing the formatting for pdf&html
• anything listed here https://github.com/alicevision/meshroom-manual/projects

• install pip and the rtd theme

pip install sphinx  sphinx_rtd_theme

• in your cli, navigate to the meshroom_doc directory
• type make html (this will re-/build the html doc)

For other build methods read the sphinx documentation

Why Restructured Text?

• can be converted to various formats, including html and pdf using Sphinx

How to edit and preview Restructured Text?

• You can use Atom with the RestructuredText Preview Pandoc Plugin

Release versions

Format: v00.00.000

Example: v19.02.001 doc for Meshroom 2019.2, update 001