Go to file

Petr Kovar 77f5365c8a Fix all sphinx errors & warnings

* tripleo-docs now passes sphinx-build -W test.
* Remove unneeded files.
* Don't mix toctree with includes to avoid duplicate labels.
* Add a common file for link references shared across docs.
* Make cross-references work across files.
* Move upload_single_image

Change-Id: I319e0d4e4dd03b7f769d9d38ad2829d6cc9a679a
Depends-On: I839a593df2116264112a6060f1f306910cfba197

2017-02-06 15:14:05 +01:00

doc/source

Fix all sphinx errors & warnings

2017-02-06 15:14:05 +01: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

H803 hacking have been deprecated

2016-12-21 22:36:39 +08:00

README.rst

Team and repository tags

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.