About

Read the latest version on https://meshroom-manual.readthedocs.io/en/latest/ download the PDF from https://readthedocs.org/projects/meshroom-manual/downloads/

This is documentation is work in progress.

See Project ToDo for details.

How to contribute

• 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
• checking grammar and spelling, fixing typos
• anything listed here https://github.com/alicevision/meshroom-manual/projects

How to Build

• install Python 3

• install a latex package

• install pip and the rtd theme

  pip install -r requirements.txt

• in your cli, navigate to the meshroom-manual directory

• type make html (this will re-/build the html doc)

For other build methods read the sphinx documentation.

FAQ

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
• Typora is a friendly editor
• Visual Studio Code with the reStructuredText extension

Release versions

Format: v00.00.000

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