Go to file

Sorin Sbarnea abca6e975e Upgrade hacking fixed conf.py linting

One conf.py was failing to pass falke8 and the other one was excluded.
Removed exclusion and fixed these filex as this is a more future proof
approach.

Before this change a clean clone of this repository would have failed
on `tox -e pep8`.

Change-Id: Ib8337aa6129acb515e33846c0635b582d1eedb8b

2018-11-19 11:18:17 +00:00

_custom

Don't keep shrinking font when nesting admonitions

2018-10-18 14:05:16 +02:00

_templates

Unify undercloud upgrade steps

2017-10-17 15:25:38 +02:00

deploy-guide/source

Upgrade hacking fixed conf.py linting

2018-11-19 11:18:17 +00:00

doc/source

Upgrade hacking fixed conf.py linting

2018-11-19 11:18:17 +00: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

Upgrade hacking fixed conf.py linting

2018-11-19 11:18:17 +00:00

tox.ini

Upgrade hacking fixed conf.py linting

2018-11-19 11:18:17 +00: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.