This repository contains the source files to build the Ubuntu Core documentation, which is published here:
The documentation is written in Markdown and built with Sphinx, all taken from the Documentation starter pack
_.
Install prerequisite software
To install the prerequisites:
.. code-block:: none
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:
.. code-block:: none
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.
.. LINKS
.. _`Documentation starter pack`: https://github.com/canonical/sphinx-docs-starter-pack/tree/main
## Hi there π
<!--
**WilSalBot/WilSalBot** is a β¨ _special_ β¨ repository because its `README.md` (this file) appears on your GitHub profile.
Here are some ideas to get you started:
- π Iβm currently working on ...
- π± Iβm currently learning ...
- π― Iβm looking to collaborate on ...
- π€ Iβm looking for help with ...
- π¬ Ask me about ...
- π« How to reach me: ...
- π Pronouns: ...
- β‘ Fun fact: ...
-->