OpenStack Charms - Deployment Guide
Go to file
Peter Matulis 289f61afc9 Up sphinx for Python 3.10 - Jammy
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
2023-01-03 13:13:44 -05:00
deploy-guide Merge "Improve software specfication text" 2022-09-02 13:34:56 +00:00
.gitignore Extra bits 2017-06-19 10:43:50 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:31:48 +00:00
.zuul.yaml Update Zuul file list 2018-10-12 21:24:37 +02:00
LICENSE Extra bits 2017-06-19 10:43:50 +01:00
README.md Convert README to markdown 2021-03-24 15:14:27 -04:00
requirements.txt Up sphinx for Python 3.10 - Jammy 2023-01-03 13:13:44 -05:00
setup.cfg Convert README to markdown 2021-03-24 15:14:27 -04:00
setup.py Initial baseline 2017-06-19 10:15:07 +01:00
tox.ini Fix up upgrade order 2022-04-05 23:33:24 -04:00

README.md

OpenStack Charms Deployment Guide

tags

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 Developers Guide). For specific guidance on working with the documentation hosted on docs.openstack.org please read the OpenStack Documentation Contributor Guide.