1b3231d83c
Due to missing spaces, some of the content in the installation guide is displayed as blockquote without being really quoted content. This change adds the needed spaces to remove the generated HTML blockquotes. The repositories.txt file gets included at different locations and that file contained the formatting spaces which were needed from the location which includes that file. It's most of the time better to do the indentation at the ".. include" level and leave the file which gets included *without* indentation. Because here, the indentation in the included file worked for some includes but not for all, because the content got used at different indentation levels. That made it necessary to touch the includes in basic_deployment and post_deployment too. Follow up patches will deal with the other install guide sections more in details. Change-Id: Ie2e7fea6d92f7742d23e22452e394b8ff40975eb |
||
---|---|---|
_custom | ||
_templates | ||
deploy-guide/source | ||
doc/source | ||
.gitignore | ||
.gitreview | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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.