Source for e3 documentation hosted on GitHub pages: https://epics-e3.github.io
The documentation is built using Sphinx and MyST, stylized with the Furo theme. All files are written in Markdown, none in reStructuredText.
The deployment is updated on merge into the default (main) branch.
With conda: conda env create -f environment.yml && conda activate e3-docs-dev && make html
Or use the same container as CI:
docker run --rm -v $(pwd):/docs registry.esss.lu.se/ics-docker/sphinx sphinx-build -M html src build
Supports all the syntax of the CommonMark Markdown but also several extensions to CommonMark (often called MyST Markdown syntax). Additional features include sphinx-design components and copy buttons on code blocks.