Go to file

Brad P. Crochet be73a19f14 Update docs to reflect changes to update command

The update command no longer requires --templates and --environment-file
args. This reflects that change in the docs.

Change-Id: I98416a1eda647d2725ce960b7f70a8392c9d9c93
Depends-On: I8aa6262716534dec7b51e64f491d7131c359f802

2016-10-12 08:16:18 -04:00

doc/source

Update docs to reflect changes to update command

2016-10-12 08:16:18 -04: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

Update README files for TripleO documentation

2016-01-14 16:10:32 +00:00

requirements.txt

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

setup.cfg

Merge "remove python 2.6 trove classifier"

2016-03-22 16:45:13 +00:00

setup.py

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

test-requirements.txt

Initial import of TripleO docs

2015-09-01 21:14:49 -04:00

tox.ini

Update the tox config to build the docs by default

2016-03-21 08:49:10 +00:00

README.rst

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.