openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
280 Commits 3 Branches 0 Tags 17 MiB
e63bc9c0ab
Go to file
Flavio Percoco e63bc9c0ab Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/65852673eba54e723401f2ef049673b2\n'

Change-Id: Ied7ae786a47a2b523e68bd7c9d6554e9822a95a3
2016-11-25 14:29:00 +01:00
doc/source Merge "Make it clear that removing ironic-inspector.sqlite is for Liberty only" 2016-11-23 15:59:30 +00: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 Show team and repo badges on README 2016-11-25 14:29:00 +01: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 Remove discover from test-requirements 2016-07-21 07:57:37 +00:00
tox.ini Update the tox config to build the docs by default 2016-03-21 08:49:10 +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.