https://github.com/cryptpad/documentation
Documentation for CryptPad, a collaboration suite that is encrypted and open-source.
https://github.com/cryptpad/documentation
cryptpad docs documentation sphinx
Last synced: about 1 month ago
JSON representation
Documentation for CryptPad, a collaboration suite that is encrypted and open-source.
- Host: GitHub
- URL: https://github.com/cryptpad/documentation
- Owner: cryptpad
- License: cc-by-4.0
- Created: 2020-08-14T14:42:59.000Z (over 5 years ago)
- Default Branch: staging
- Last Pushed: 2026-01-20T09:24:31.000Z (2 months ago)
- Last Synced: 2026-01-20T18:55:40.248Z (2 months ago)
- Topics: cryptpad, docs, documentation, sphinx
- Language: HTML
- Homepage: https://docs.cryptpad.org
- Size: 70.9 MB
- Stars: 32
- Watchers: 12
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# CryptPad Documentation
## Installation
We use [UV](https://docs.astral.sh/uv/#getting-started) to maintain the development environment for the documentation. Install dependencies with
```bash
uv sync
```
Activate the environment with
```bash
source ./.venv/bin/activate
```
Keep `requirements.txt` up to date with the UV venv by running
```bash
uv export --format requirements-txt > requirements.txt
```
### Pip
```bash
pip install -r requirements.txt
```
## Build
English `en` is the default language.
to build the default:
```bash
make html
```
to build another language, e.g. French:
```bash
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](https://weblate.cryptpad.org/projects/user-guide/) for the user guide. If your language is not listed, please [contact the development team](https://cryptpad.fr/contact.html) 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:
```bash
sphinx-intl update -p _build/locale
```
To generate `.po` files for a new language e.g. French:
```bash
make gettext
sphinx-intl update -p _build/gettext -l fr
```
[update.sh](update.sh) updates all languages after English has changed:
```bash
./update.sh
```
[build.sh](build.sh) builds all languages into the `www` folder:
```bash
./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 `` 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](LICENSE) (CC-BY).
The theme is modified from the [Krita documentation](https://invent.kde.org/documentation/docs-krita-org/-/tree/master/) and licensed under the [GNU Free Documentation License](_themes/theme/LICENSE).