Skip to content

laboluz/Mosaic-Manual

 
 

Repository files navigation

Mosaic Manual

The scope of the manual is the Mosaic application.

Contributions

Send a pull request to this repository with your edits. Major changes like new pages and complete overhauls are welcome, as well as minor fixes like grammar, spelling, and reorganization. Your PR will be accepted if it is a net positive benefit to readers.

Building

Install Sphinx 1.8.1. Newer versions do not generate formulas and image tags properly.

pip install sphinx==1.8.1
pip install sphinx-markdown-tables
pip install sphinx_rtd_theme
pip install sphinx-intl

Install recommonmark 0.4.0.

pip install recommonmark==0.4.0

Build with

make html

Generate .pot and .po files for translations with

make gettext
sphinx-intl update -p _build/gettext -l en -l es

Generate translated documents with

make -e SPHINXOPTS="-Dlanguage='en'" html
make -e SPHINXOPTS="-Dlanguage='es'" html

The output should be generated in _build/html.

License

All documentation text in this repository is licensed under CC BY-SA 4.0.

Releases

No releases published

Packages

No packages published

Languages

  • Python 80.3%
  • CSS 10.1%
  • Makefile 9.6%