This is the source of the online document that is hosted here. It is built using Sphinx and the repository was forked from "the template for the Read the Docs tutorial".
As the rst files in the repo are updated, the online document is updated automatically. Same applies for the translations (explained below). In order to intruduce the content to the repository, a local installation is advised.
Setup the virtual environment and install the requirements
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
That's it!
For a local compilation, all that is needed is to launch
<project>/docs$ make html
from the docs directory. All the html files appear in the <project>/build/html/ directory.
If everything is building correctly, in order for the changes to appear on the website here, just push the changes to github.
Once rst files are modified, the changes only apply for the parent, English version. These changes have to be introduced in the translation .po files. Luckily this repository has the internationalization already setup, both in the pushed files and the virtual enviroment requirements.
Once the changes to the rst files are made just execute
<project>/docs/source$ sphinx-build -b gettext . _build/gettext
<project>/docs/source$ sphinx-intl update -p _build/gettext -l es -l tr
The first command builds the templates .pot files and the second one updates the actual .po files to be translated. Both have to be executed from <project>/docs/source. All the final .po files will appear at <project>/docs/source/locales. These files have to be translated either manually via a local tool like poedit or sent to a translation platform like transifex (which is free for open source projects), and has to be translated by the translators.
Before pushing the translated to the repository it might be a good idea to build the translated pages. For more information check the official tutorial.
sphinx-build -b html -D language=en . _build/html/en
sphinx-build -b html -D language=tr . _build/html/tr
sphinx-build -b html -D language=es . _build/html/es
Pushing the .po files will create the new versions of the readthedocs translated pages Spanish here, Turkish here. The different languages are also accesible from the footer menu. They are setup according to this guide
For more information read the tutorial here:
https://docs.readthedocs.io/en/stable/tutorial/
This repo is developed as part of project "Judeo-Spanish: Connecting the two ends of the Mediterranean" carried out by Col·lectivaT and Sephardic Center of Istanbul within the framework of the “Grant Scheme for Common Cultural Heritage: Preservation and Dialogue between Turkey and the EU–II (CCH-II)” implemented by the Ministry of Culture and Tourism of the Republic of Turkey with the financial support of the European Union. The content of this website is the sole responsibility of Col·lectivaT and does not necessarily reflect the views of the European Union.