289f61afc9
On Jammy hosts the docs will not build due to an incompatibility between Sphinx and Python 3.10. Increase Sphinx version in requirements.txt to at least 4.2. Change-Id: I34d9c1a6baa042535ea74758c9a4b51f97e6965a
OpenStack Charms Deployment Guide
The OpenStack Charms Deployment Guide is the main source of information for the usage of the OpenStack Charms.
Building
To build the guide run this simple command:
tox
The resulting HTML files will be found in the deploy-guide/build/html
directory. These can be opened individually with a web browser or hosted by a
local web server.
Contributing
Documentation issues can be filed on Launchpad.
This repository is under version control and is managed via the OpenStack Gerrit system (see the OpenDev Developer’s Guide). For specific guidance on working with the documentation hosted on docs.openstack.org please read the OpenStack Documentation Contributor Guide.