https://github.com/d3cod3/mosaic-manual
Mosaic Manual
https://github.com/d3cod3/mosaic-manual
Last synced: 3 months ago
JSON representation
Mosaic Manual
- Host: GitHub
- URL: https://github.com/d3cod3/mosaic-manual
- Owner: d3cod3
- Created: 2020-02-26T11:00:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-06T09:48:30.000Z (over 4 years ago)
- Last Synced: 2025-01-01T22:35:23.468Z (5 months ago)
- Language: HTML
- Homepage: https://mosaic.d3cod3.org/manual
- Size: 6.88 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](http://www.sphinx-doc.org/en/stable/) 1.8.1. Newer versions do not generate formulas and image tags properly.
```bash
pip install sphinx==1.8.1
pip install sphinx-markdown-tables
pip install sphinx_rtd_theme
pip install sphinx-intl
```
Install [recommonmark](https://github.com/rtfd/recommonmark) 0.4.0.
```bash
pip install recommonmark==0.4.0
```
Build with
```bash
make html
```
Generate .pot and .po files for translations with
```bash
make gettext
sphinx-intl update -p _build/gettext -l en -l es
```
Generate translated documents with
```bash
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](https://creativecommons.org/licenses/by-sa/4.0/).