openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
359 Commits 3 Branches 0 Tags 17 MiB
19e09e078a
Go to file
Ben Nemec 19e09e078a Enable warning-is-error for docs job 
As of I319e0d4e4dd03b7f769d9d38ad2829d6cc9a679a, the warnings in the
tripleo-docs build should be fixed and it would be good to keep it
that way.

This was added in sphinx 1.5, which is now in global-requirements.
We should add a requirements sync job to this repo so we don't get
out of date again.

Note that since this was originally proposed, some new warnings
have been added to the repo.  These are also fixed in this commit.

Change-Id: Ibc673109878d5edc9a2772e7e0650a1ed31a6cc7
2017-02-27 17:15:41 +00:00
doc/source Enable warning-is-error for docs job 2017-02-27 17:15:41 +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 Enable warning-is-error for docs job 2017-02-27 17:15:41 +00:00
setup.py Initial import of TripleO docs 2015-09-01 21:14:49 -04:00
test-requirements.txt Enable warning-is-error for docs job 2017-02-27 17:15:41 +00:00
tox.ini H803 hacking have been deprecated 2016-12-21 22:36:39 +08: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.