mirror of
https://github.com/chatmail/core.git
synced 2026-04-06 07:32:12 +03:00
To preview the docs, run:
```
scripts/build-python-docs.sh
firefox dist/html/index.html
```
I have removed the Makefile because modern Sphinx Makefile is just a
wrapper for `sphinx-build -M`:
3596590317/sphinx/templates/quickstart/Makefile.new_t
and sphinx-quickstart even has an option `--no-makefile`.
`make.bat` makes even less sense.
In `scripts/build-python-docs.sh` I use `sphinx-build` directly
without `make` wrapper.
Concourse CI pipeline
docs_wheels.yml is a pipeline for Concourse CI
that builds C documentation, Python documentation, Python wheels for x86_64
and aarch64 and Python source packages, and uploads them.
To setup the pipeline run
fly -t <your-target> set-pipeline -c docs_wheels.yml -p docs_wheels -l secret.yml
where secret.yml contains the following secrets:
c.delta.chat:
private_key: |
-----BEGIN OPENSSH PRIVATE KEY-----
...
-----END OPENSSH PRIVATE KEY-----
devpi:
login: dc
password: ...
Secrets can be read from the password manager:
fly -t b1 set-pipeline -c docs_wheels.yml -p docs_wheels -l <(pass show delta/b1.delta.chat/secret.yml)