README.md

CryptPad Documentation

Installation

Using Poetry

poetry install

or Pip

pip install -r requirements.txt

Keep requirements.txt up to date with the Poetry environment by running

poetry export -f requirements.txt --output requirements.txt

Build

English en is the default language.

to build the default:

make html

to build another language, e.g. French:

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

View the result in /_build/html/

Translations

If you are interested in translating this documentation, you can use our Weblate project for the user guide. If your language is not listed, please contact the development team to add it.

To add a new language

sphinx-intl update --pot-dir _build/gettext -l de

change de to the locale you want to add

Translated builds

To update after default language has changed:

sphinx-intl update -p _build/locale`

To generate .po files for a new language e.g. French:

make gettext
sphinx-intl update -p _build/gettext -l fr

update.sh updates all languages after English has changed:

./update.sh

build.sh builds all languages into the www folder:

./build.sh

Adding a language

1. add language code to LANG and leave an empty line at the end of the file
2. add the <option> to _themes/theme/layout.html line 109

translated images

Images for English are in the /images folder.
To provide localised versions of images, place them in a folder such as images/fr/.

Licenses

The content of this documentation is licensed under the Creative Commons Attribution 4.0 International (CC-BY).

The theme is modified from the Krita documentation and licensed under the GNU Free Documentation License.