openstack/tripleo-docs
Code Issues Proposed changes
RETIRED, Documentation for TripleO
585 Commits 3 Branches 0 Tags 17 MiB
4592ed06f9
Go to file
Markus Zoeller 4592ed06f9 docs: remove ALL the unnecessary blockquotes 
Due to missing/superflous spaces, some of the content in the
guide is displayed as blockquote without being really quoted
content. This change adds/removes spaces to remove ALL the
generated HTML blockquotes.

Change-Id: I25b0d9fa64cd474a844b5f3e6c126395a4e80f2c
2017-10-06 09:51:25 +02:00
_custom Remove source admonition 2017-09-29 16:19:18 +00:00
_templates Remove source admonition 2017-09-29 16:19:18 +00:00
deploy-guide/source Update docs structure 2017-07-07 20:04:52 +00:00
doc/source docs: remove ALL the unnecessary blockquotes 2017-10-06 09:51:25 +02:00
.gitignore Update .gitignore 2017-08-23 16:46:44 +05:30
.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 Switch to openstackdocstheme 2017-06-23 14:01:52 -04:00
setup.cfg Enable warning-is-error for docs job 2017-02-27 17:15:41 +00:00
setup.py Manually sync global-requirements 2017-05-19 11:41:37 +02:00
test-requirements.txt Update docs structure 2017-07-07 20:04:52 +00:00
tox.ini Basic structure of TripleO Deployment Guide 2017-03-27 08:00:12 -04: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.