Ubuntu Core documentation

Ubuntu Core documentation can currently be found here: https://ubuntu.com/core/docs

The above documentation is published directly from Discourse: https://discourse.ubuntu.com/c/ubuntu-core-docs/47

November, 2024: Work in progress

This repository contains the source files to build the Ubuntu Core documentation outside of Discourse. We are actively working to migrate the source material to this repository.

The documentation is written in Markdown and built with Sphinx, all taken from the Documentation starter pack.

Build the documentation

Install prerequisite software

To install the prerequisites:

make install

This will create a virtual environment (.sphinx/venv) and install dependency software (.sphinx/requirements.txt) within it.

View the documentation

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.