README.md

FIN4Documentation

Our documentation is located at fin4xplorer.readthedocs.io in English and German.

New commits in this repository trigger a new build there.

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Update translations

pip install sphinx-intl

In the docs folder:

To update the .po files for the German translation in docs/locales/de run:

sphinx-intl update -p _build/gettext -l de

If you haven't done so before or if it doesn't update properly, delete the _build folder and run this build command:

sphinx-build -b gettext . _build/gettext

Then run the update command again.

Build locally

Run in docs:

make html

During writing: build upon saving

A nice convenience for automatically building locally upon saving a .rst file is using a "Save and Run" plugin like this one for Visual Studio Code.

Add to settings.json:

"saveAndRun": {
    "commands": [
        {
            "match": "\\.rst$",
            "cmd": "make -C ~/git/FIN4Documentation/docs html",
            "useShortcut": false,
            "silent": false
        }
    ]
}