openstack/tripleo-docs
Code Issues Proposed changes
c3e8fe6082
tripleo-docs/README.rst
ShangXiao c3e8fe6082 Replace the old links in docs 
Replace the old http links with the lastest ones according
to the OpenStack websites.

Change-Id: I0adaabad70c67df885cccce744b4db447c8a0f75
2018-02-27 01:23:16 -08:00

1.7 KiB
Raw Blame History

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.