openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
1,039 Commits 3 Branches 0 Tags 17 MiB
c87c930be6
Go to file
Natal Ngétal c87c930be6 [Configuration] Update min tox version. 
The commands used by constraits need at least tox 2.0, update to reflect
reality, which should help with local running constraints targets.

Change-Id: I069abc89dcd21b072a25c4375af7d78e5123b489
2018-12-06 10:22:59 +01:00
_custom fixed Useless variable declaration 2018-11-27 16:23:14 +08:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Upgrade hacking fixed conf.py linting 2018-11-19 11:18:17 +00:00
doc/source [Documentation] Typo. 2018-12-05 10:13:56 +01:00
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.gitreview Add .gitreview 2015-09-09 10:09:29 +01:00
.zuul.yaml Cleanup zuul.yaml 2018-09-22 16:25:57 +02:00
README.rst Replace the old links in docs 2018-02-27 01:23:16 -08:00
requirements.txt Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-04 17:49:29 +08:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Upgrade hacking fixed conf.py linting 2018-11-19 11:18:17 +00:00
tox.ini [Configuration] Update min tox version. 2018-12-06 10:22:59 +01:00

README.rst

Team and repository tags

image

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.