This is the repository where user documentation for Kolibri <https://learningequality.org/kolibri/> is maintained. To read the documentation visit kolibri.readthedocs.io <https://kolibri.readthedocs.io/>.
To help translate the documentation, please contact our i18n team at i18nteam@learningequality.org.
You will need an environment with make <https://en.wikipedia.org/wiki/Make_(software)>__
.. code-block:: bash
mkvirtualenv -p python3 kolibri-docs
pip install -r requirements.txt
Build and run:
.. code-block:: bash
make docs
You should now be able open the built docs with a web browser at docs/_build/html/index.html.
You can also have the docs automatically build and reload:
.. code-block:: bash
sphinx-autobuild docs docs/_build/html
You should now be able open the automatically-rebuilding docs with a web browser at http://127.0.0.1:8000.
Some commands related to i18n:
.. code-block:: bash
$ make docs-translated lang=es
$ make crowdin-install
$ CROWDIN_API_KEY="your-secret-key" make crowdin-download crowdin-branch=release-v0.7.x
When a new release of Kolibri happens, we track that release in a branch here with the exact same name. We build this branch on Read The Docs.
When a new release happens and the English documentation is finalized, the source messages for translation are uploaded to CrowdIn.
The languages (you're always welcome to request a new one!) are then worked out by translators and approved. Once a language is improved sufficiently, we can fetch the latest strings from CrowdIn and open up a new Pull Request here for the appropriate branch.
.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png :alt: Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>__