openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
721 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis 5675455d24
Fix Sphinx module version dependencies 
Fix build errors due to Sphinx module dependencies by pinning
versions for Sphinx and a Sphinx module.

Change-Id: I2753aedb8f94039d18948c2a2f9b155173b171b2
Signed-off-by: Peter Matulis <peter.matulis@canonical.com>
 		2024-02-29 20:21:14 -05:00
doc Fix ironic-dashboard channel 2023-11-10 07:21:34 +00:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview Update versioning for 2023.1 2023-06-13 19:18:34 -04: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 Fix Sphinx module version dependencies 2024-02-29 20:21:14 -05:00
setup.cfg Remove some deprecation build warnings 2023-01-09 10:45:39 -05: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.