Update for OpenDev
Update URLs for recent OpenDev change. Change-Id: I0f7e48f054da0eeb12593c5756e5f5f47a577f4f
|4 days ago|
|api-quick-start||3 weeks ago|
|api-ref||2 years ago|
|common||7 months ago|
|firstapp||4 days ago|
|tools||1 year ago|
|www||4 months ago|
|.gitignore||3 years ago|
|.gitreview||6 days ago|
|.zuul.yaml||1 year ago|
|LICENSE||7 years ago|
|README.rst||4 days ago|
|bindep.txt||1 year ago|
|doc-tools-check-languages.conf||1 year ago|
|test-requirements.txt||1 year ago|
|tox.ini||6 months ago|
This repository contains API documentation for the OpenStack project.
For details, see OpenStack Documentation Contributor Guide, which includes these pages:
- API Quick Start
- API Guide (in progress)
In addition to these documents, this repository contains:
- Landing page for developer.openstack.org:
- Writing your first OpenStack application tutorial (in progress):
To build the documentation locally, you must install Python and Python Tox.
To install Tox for Ubuntu 14.04 or later:
apt-get install python-tox python-dev libxml2-dev libxslt1-dev
To build all the documentation after installing Python and Tox:
tox -e docs
To build an individual document, such as the API Guide:
tox -e api-quick-start
The locally-built output files are found in a
To build the "Writing your first OpenStack application" tutorial, you must install Graphviz.
To install Graphviz for Ubuntu 12.04 or later or Debian 7 ("wheezy") or later:
apt-get install graphviz
On Fedora 22 and later:
dnf install graphviz
zypper install graphviz
On Mac OSX with Homebrew installed:
brew install graphviz
Refer to the OpenStack Documentation Contributor Guide for more information.
To use the same tests that are used as part of our Jenkins gating jobs, install the Python tox package and run
tox from the top-level directory.
To run individual tests:
tox -e linters- Niceness tests
tox -e checkbuild- Builds all of the documents in this repository
To run these tests, the Tox package uses the OpenStack doc tools package.
Our community welcomes everyone who is 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 meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
To contribute to the documents, see OpenStack Documentation Contributor Guide.
File bugs on Launchpad and not through GitHub:
To learn more about the OpenStack project, see OpenStack.