openstack
/
tripleo-docs
Code Issues Proposed changes
Documentation for TripleO
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1,508 Commits
3 Branches
0 Tags
17 MiB
JavaScript 60.8%
Python 15.8%
HTML 13.8%
CSS 9.6%
 
 
 
 
master
stable/zed
stable/wallaby
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6151147daf'
${ noResults }
Go to file
James Slagle 6151147daf Update tox.ini for tripleo-docs 
Removes the pep8 and bindep tox environments. pep8 did not run
successfully as there is no test-requirements.txt file, and there is
nothing to test anyway. bindep also has nothing to test, so it's also
removed.

The deploy-guide tox environment is added to the default list so that
just running "tox" results in a full build of the documentation
including the user and deploy guide.

Change-Id: I1990556fec47905d2e137b51bcaefd15fe597dea
 		2 years ago
_custom Introduce new TLS-e guide 3 years ago
_templates Unify undercloud upgrade steps 6 years ago
deploy-guide/source Update Derived Parameters doc for new name 2 years ago
doc Add some docs for pre_deploy_step_tasks 2 years ago
.gitignore Update 3rd party container build with new tooling 3 years ago
.gitreview OpenDev Migration Patch 4 years ago
.zuul.yaml Run deploy guide jobs 4 years ago
README.rst PDF documentation build 4 years ago
bindep.txt Add a bindep. 4 years ago
requirements.txt Switch to newer openstackdocstheme and reno versions 3 years ago
setup.cfg Cleanup py27 support and docs 3 years ago
setup.py Cleanup py27 support and docs 3 years ago
tox.ini Update tox.ini for tripleo-docs 2 years ago

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,pdf-docs,deploy-guide

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.