openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
660 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis b3dca9c775 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: Id78d53132a2a021e41cf46696e79ba0b89b983d2
 		2023-01-03 13:01:03 -05:00
doc Merge "Review op: Auto Glance image updates" 2022-12-12 10:16:46 +00:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:52 +00:00
.zuul.yaml Add a spellchecker 2022-04-11 12:45:10 -04:00
HACKING.rst Add deploy guide link and release schedules 2017-11-27 19:52:38 +00:00
LICENSE Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
README.md Enhance doc contribution guidelines 2022-03-14 11:23:19 -04:00
bindep.txt Add a spellchecker 2022-04-11 12:45:10 -04:00
rebuild Rebuild to republish 2018-06-11 16:15:04 -05:00
requirements.txt Up sphinx for Python 3.10 - Jammy 2023-01-03 13:01:03 -05:00
setup.cfg Convert README to markdown 2021-03-24 15:10:23 -04:00
setup.py Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
tox.ini Add linkchecking 2022-09-18 12:20:20 -04:00

README.md

OpenStack Charm Guide

tags

The OpenStack Charm Guide is the main source of information for the OpenStack Charms.

Building

To build the guide run this simple command:

tox

The resulting HTML files will be found in the doc/build/html directory. These can be opened individually with a web browser or hosted by a local web server.

Contributing

This repository is under version control and is managed via the OpenStack Gerrit system (see the OpenDev Developer’s Guide). The Documentation contributions page outlines how to contribute to this project.

Bugs

Documentation issues can be filed on Launchpad.