openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
942 Commits 3 Branches 0 Tags 17 MiB
fb690db721
Go to file
Martin André fb690db721 Consistently use literals for long options 
Otherwise the `--` that prefix the long option name gets rendered as
`–`. This commit changes all instances of long options to literals.
Short options, and more generally commands, should also be changed to
literals in order to have consistent doc layout.

Change-Id: I920e5866387d8bb5b498f2635887dfb9de8a124b
2018-10-01 14:28:32 +02:00
_custom Amend minor update docs for Rocky 2018-08-28 14:20:40 +02:00
_templates Unify undercloud upgrade steps 2017-10-17 15:25:38 +02:00
deploy-guide/source Update docs structure 2017-07-07 20:04:52 +00:00
doc/source Consistently use literals for long options 2018-10-01 14:28:32 +02: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 Replace the old links in docs 2018-02-27 01:23:16 -08:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Drop duplicate openstackdocstheme requirement 2018-01-29 13:50:47 -05:00
tox.ini fix tox python3 overrides 2018-07-16 07:47:47 +00: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.