diff --git a/README.rst b/README.rst index 39a9f54fb..1ea0e71fb 100644 --- a/README.rst +++ b/README.rst @@ -106,6 +106,9 @@ For developers that want to ease the translation process, please read `this docu Building -------- +Building HTML +============= + 1. Install `pipenv` - https://pipenv.readthedocs.io/en/latest/ 2. Create a Python environment (typically inside this repository): `pipenv --python 3.9` 3. Change into the environment: `pipenv shell` @@ -121,6 +124,16 @@ When editing the documentation installing `sphinx-autobuild` though pip can be h 3. Watch for file changes `make SPHINXBUILD=sphinx-autobuild html` 4. Open http://127.0.0.1:8000 in the browser and start editing +Building PDF +============ + +1. Follow instructions for "Building HTML" above +2. Install `latexmk` and `texlive-latex-extra` - https://pipenv.readthedocs.io/en/latest/ +3. Create a Python environment (typically inside this repository): `pipenv --python 3.9` +4. Change into the environment: `pipenv shell` +5. Install the dependencies `pip install -r requirements.txt` +6. Now you can use `make ...` to build all the stuff - for example `make pdf` to build the PDF flavor of all manuals + Icons -----