OpenStack Manuals
Go to file
Andreas Jaeger 6e245635d1 Reorganize appendix in toc
Move glossary and appendix in one chapter called appendix.

This has been done already for arch-design and ops-guide, do it for the
other guides. Share common appendix.

Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c
2017-03-31 07:27:29 +02:00
doc Reorganize appendix in toc 2017-03-31 07:27:29 +02:00
releasenotes Imported Translations from Zanata 2017-03-23 10:54:03 +00:00
tools Merge "Disable branch root-marker" 2017-03-25 04:40:18 +00:00
www [ops-guide] move operations content into top level 2017-03-22 16:06:16 +09:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
CONTRIBUTING.rst Use https instead of http for openstack sites 2017-01-31 07:36:48 +09:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Indicate bindep is for Linux only 2017-03-08 13:43:41 +00:00
bindep.txt Remove obsolete binary packages from install 2017-02-24 13:27:52 +00:00
doc-tools-check-languages.conf [ha-guide-draft] Create ha-guide draft directory 2017-03-20 11:34:24 +00:00
projects.txt Stop syncing common to api-site/first-app 2017-02-11 22:04:19 +09:00
test-requirements.txt Update openstackdocstheme requirement 2017-03-23 14:13:16 +01:00
tox.ini Does not build PDF by default with tox -e docs 2017-03-01 20:20:27 +09:00


Team and repository tags


OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

  • Administrator Guide
  • Architecture Design Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • Documentation Contributor Guide
  • End User Guide
  • High Availability Guide
  • Installation Tutorials
  • Networking Guide
  • Operations Guide
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

  • contents: www


Various manuals are in subdirectories of the doc/ directory.


Some pre-requisites are needed to build the guides. If you are using a Linux operating system you can generate a report of missing local requirements with the bindep command:

$ tox -e bindep

All guides are in the RST format. You can use tox to prepare virtual environment and build all guides (HTML only):

$ tox -e docs

You can also build a specific guide.

For example, to build OpenStack End User Guide, use the following command:

$ tox -e build -- user-guide

You can find the root of the generated HTML documentation at:


To build a specific guide with a PDF file, add a -pdf option like:

$ tox -e build -- user-guide --pdf

The generated PDF file will be copied to the root directory of the generated HTML documentation.

If you get this message make: xelatex: No such file or directory it means your local environment does not have LaTeX installed. Read Getting LaTeX for instructions.

Testing of changes and building of the manual

Install the Python tox package and run tox from the top-level directory to use the same tests that are done as part of the OpenStack CI jobs.

If you like to run individual tests, run:

  • tox -e checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals
  • tox -e checkniceness - to run the niceness tests
  • tox -e linkcheck - to run the tests for working remote URLs

The tox command uses the openstack-doc-tools package to run the tests.

Generated files

Some documentation files are generated using tools. These files include a do not edit header and should not be modified by hand. Please see Generated files.


Bugs should be filed on Launchpad, not GitHub:


Refer to to see where these documents are published and to learn more about the OpenStack project.