Documentation for TripleO
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jose Luis Franco Arza 159cce3c4a Unify undercloud upgrade steps 5 years ago
_custom Unify undercloud upgrade steps 5 years ago
_templates Unify undercloud upgrade steps 5 years ago
deploy-guide/source Update docs structure 5 years ago
doc/source Unify undercloud upgrade steps 5 years ago
.gitignore Update .gitignore 5 years ago
.gitreview Add .gitreview 7 years ago
README.rst Show team and repo badges on README 6 years ago
requirements.txt Switch to openstackdocstheme 6 years ago
setup.cfg Enable warning-is-error for docs job 6 years ago Manually sync global-requirements 6 years ago
test-requirements.txt Update docs structure 5 years ago
tox.ini Basic structure of TripleO Deployment Guide 6 years ago


Team and repository tags


TripleO Documentation

This is the documentation source for the TripleO project. You can read the generated documentation at TripleO Docs.

You can find out more about TripleO at the TripleO Wiki.

Getting Started

Documentation for the TripleO project is hosted on the OpenStack Gerrit site. You can view all open and resolved issues in the openstack/tripleo-docs project at TripleO Reviews.

General information about contributing to the OpenStack documentation available at OpenStack Documentation Contributor Guide

Quick Start

The following is a quick set of instructions to get you up and running by building the TripleO documentation locally. The first step is to get your Python environment configured. Information on configuring is available at Python Project Guide

Next you can generate the documentation using the following command. Be sure to run all the commands from within the recently checked out repository.

tox -edocs

Now you have the documentation generated for the various available formats from the local source. The resulting documentation will be available within the doc/build/ directory.