RETIRED, Documentation for TripleO

Go to file

Jenkins 42468193ef Merge "Switch trunk/cbs/buildlogs to use https"		2017-03-24 12:38:13 +00:00
doc/source	Merge "Switch trunk/cbs/buildlogs to use https"	2017-03-24 12:38:13 +00:00
.gitignore	Ignore both the AUTHORS and ChangeLog files	2016-03-18 09:40:52 +00:00
.gitreview	Add .gitreview	2015-09-09 10:09:29 +01:00
README.rst	Show team and repo badges on README	2016-11-25 14:29:00 +01:00
requirements.txt	Initial import of TripleO docs	2015-09-01 21:14:49 -04:00
setup.cfg	Enable warning-is-error for docs job	2017-02-27 17:15:41 +00:00
setup.py	Initial import of TripleO docs	2015-09-01 21:14:49 -04:00
test-requirements.txt	Enable warning-is-error for docs job	2017-02-27 17:15:41 +00:00
tox.ini	H803 hacking have been deprecated	2016-12-21 22:36:39 +08:00

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.