This repository contains the source files to build the Snap documentation available at https://snapcraft.io/docs/.
The documentation is written in Markdown, built with Sphinx, and published via ReadtheDocs.
This documentation was previously hosted and published in the Snapcraft forum, and was migrated in early 2026.
To install the prerequisites:
make install
This will create a virtual environment (.sphinx/venv) and install
dependency software (.sphinx/requirements.txt) within it.
To view the documentation:
make run
This will do several things:
- activate the virtual environment
- build the documentation
- serve the documentation on 127.0.0.1:8000
- rebuild the documentation each time a file is saved
- send a reload page signal to the browser when the documentation is rebuilt
The run target is therefore very convenient when preparing to submit a
change to the documentation.