OpenStack Manuals
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.
Go to file
Jenkins cabc62a92d Merge "[network] Rework the SR-IOV guide" 7 years ago
doc Merge "[network] Rework the SR-IOV guide" 7 years ago
releasenotes/source Imported Translations from Zanata 7 years ago
tools [network] Add missing sriov-agent config opts 7 years ago
www Merge "[api] add redirect for translated quick-starts" 7 years ago
.gitignore Add "*.swo" to ".gitignore" file 7 years ago
.gitreview Add .gitreview config file for gerrit. 12 years ago
LICENSE bug 944097 adding apache license to openstack-manuals repo 11 years ago
README.rst just drop the 's' of Installation Guides in README.rst 7 years ago
bindep.txt Rename other-requirements.txt -> bindep.txt 7 years ago
doc-test.conf Remove XML file exceptions from doc-test.conf 7 years ago
doc-tools-check-languages.conf Do not translate debconf install guide for now 7 years ago
projects.txt [ha-guide] Changes after ha-guide is merged to manuals 7 years ago
test-requirements.txt Require openstackdocstheme 1.4.0 7 years ago
tox.ini remove unused path from checkniceness ignore-path 7 years ago


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 Guide
  • 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.


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

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:


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 our Jenkins gating jobs.

If you like to run individual tests, run:

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

tox will use the openstack-doc-tools package for execution of these tests.


Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.

The best way to get involved with the community is to talk with others online or at a meet up and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

If you would like to contribute to the documents, please see the OpenStack Documentation Contributor Guide.

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.