bab891464f
sphinxcontrib-mermaid 0.6.1 causes issue seen in LP bug 1916280. Newer version of sphinxcontrib-mermaid will fix so let's avoid problem with known issue. Change-Id: Iad6b3faa1a4428ce9a59efbc879bcf5a0f394cc1 Closes-Bug: #1916280
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,pdf-docs,deploy-guideNow 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.