Documentation for TripleO
JavaScript Python HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_custom
_templates
deploy-guide/source
doc/source
.gitignore
.gitreview
README.rst
requirements.txt
setup.cfg
setup.py
test-requirements.txt
tox.ini

README.rst

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.