https://github.com/alicevision/meshroom-manual
Meshroom manual and documentation
https://github.com/alicevision/meshroom-manual
alicevision documentation manual meshroom
Last synced: 7 months ago
JSON representation
Meshroom manual and documentation
- Host: GitHub
- URL: https://github.com/alicevision/meshroom-manual
- Owner: alicevision
- Created: 2019-10-17T07:18:48.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-08T18:04:31.000Z (over 1 year ago)
- Last Synced: 2025-03-20T20:14:26.899Z (7 months ago)
- Topics: alicevision, documentation, manual, meshroom
- Language: Python
- Homepage: https://meshroom-manual.readthedocs.io
- Size: 35.1 MB
- Stars: 41
- Watchers: 16
- Forks: 32
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-CC-BY-SA-4.0.md
Awesome Lists containing this project
README
[](https://creativecommons.org/licenses/by-sa/4.0/)
[](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
# 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](https://github.com/alicevision/meshroom-manual/projects) 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
```bash
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](https://atom.io/) with the [RestructuredText Preview Pandoc](https://atom.io/packages/rst-preview-pandoc) Plugin
- [Typora](https://www.typora.io) is a friendly editor
- [Visual Studio Code](https://code.visualstudio.com) with the [reStructuredText](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) extension
**Release versions**
Format: v00.00.000
Example: v19.02.001 doc for Meshroom 2019.2, update 001