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.
Emilien Macchi 11aa64e030 Document dev_mode for container image prepare 4 days ago
_custom Update the repositories file with stein. 1 month ago
_templates Unify undercloud upgrade steps 1 year ago
deploy-guide/source Upgrade hacking fixed conf.py linting 7 months ago
doc Document dev_mode for container image prepare 4 days ago
.gitignore Update .gitignore 1 year ago
.gitreview OpenDev Migration Patch 2 months ago
.zuul.yaml Cleanup zuul.yaml 8 months ago
README.rst Update openstack.org to opendev.org 1 month ago
requirements.txt Switch to openstackdocstheme 2 years ago
setup.cfg Change openstack-dev to openstack-discuss 6 months ago
setup.py Manually sync global-requirements 2 years ago
test-requirements.txt Sync Sphinx requirement 3 weeks ago
tox.ini Dynamic name version. 1 week ago

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.