sassafrastech / nemo-docs-redirect

Redirect from old docs to new docs.

nemo-docs-redirect

Old documentation for NEMO, because readthedocs doesn't support changing the slug.

Publishing

To rebuild, just push commits to main. Read the Docs will pick them up automatically.

Automatic deploys can be configured here.

Development

Local testing (verified on OSX with Python 3.7.6):

1. pip3 install -r requirements.txt
2. make html
3. open _build/html/index.html

More info at Read the Docs docs.

Upgrading dependencies

1. Temporarily change == to >= in requirements.txt
2. pip3 install -r requirements.txt --upgrade
3. pip3 freeze > requirements.txt

Working with translations

Once changes are made to the PO file in Transifex:

Pull changes from Transifex to local repo (replace "fr" with the language code you are translating):

tx pull -l fr

Then build with this modified command:

make -e SPHINXOPTS="-D language='fr'" html