This repository is the source for the top-level documentation site at docs.epics-controls.org.

This repository contains user and developer documentation for EPICS, including guides, explanations, and reference material across EPICS topics.

The published site also carries documentation built from other repositories, such as EPICS Base, which appears under docs.epics-controls.org/projects/. This repository doesn't maintain those pages.

Install dependencies from pyproject.toml and run a local preview:

$ python -m venv .venv
$ . .venv/bin/activate
$ pip install .
$ sphinx-autobuild . ./_build/html

Open http://127.0.0.1:8000 in your browser. Changes reload automatically.

See CONTRIBUTING.md.

For questions or help, use Tech-talk email, visit the mailing lists, or join EPICS Chat.