api-site/README.rst

API-Site repository

This repository contains documentation for the OpenStack project.

For details, see the OpenStack Documentation wiki page, which includes these pages and PDFs:

• API Quick Start
• API Complete Reference (web pages)
• API Reference PDFs
• API Guide (in progress)

In addition to these documents, this repository contains:

• developer.openstack.org: www
• Writing your first OpenStack application tutorial (in progress): firstapp

Prerequisites

To build the documentation, you must install Apache Maven.

To install Maven 3 for Ubuntu 12.04 or later or Debian 7 ("wheezy") or later:

apt-get install maven

On Fedora 20 or later:

yum install maven

To run tests, you must install Python Tox.

To install Tox for Ubuntu 14.04 or later:

apt-get install python-tox python-dev libxml2-dev libxslt1-dev

"Writing your First OpenStack Application" tutorial

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

On openSUSE:

zypper install graphviz

On Mac OSX with Homebrew installed:

brew install graphviz

Build and update API docs

To complete code reviews in this repository, use the standard OpenStack Gerrit workflow . For details, see Gerrit Workflow.

To build and update the API documents:

1. Open a Terminal window.

2. Change into a directory where you want to clone api-site.

3. Run this command to clone openstack/api-site:

   git clone https://git.openstack.org/openstack/api-site

4. CD into the api-site directory.

5. Run these commands to ensure that you have the latest changes:

   git remote update
   git checkout master
   git pull origin master

6. To check out a new branch:

   git checkout -b "*my_branch*"

   Otherwise, to check out an existing review:

   git review -d change-number /* where change-number is the change number of the review

7. Make your changes.

8. Run this command to build the docs locally:

   mvn clean generate-sources

#. To check in your changes, see Gerrit Workflow.

• The root of the generated HTML (API site) documentation is:

  api-site/api-ref/target/docbkx/html/api-ref.html

• The root of the generated API guide (in progress) is:

  api-site/api-guide/target/docbkx/webhelp/api-guide/index.html

• The generated PDFs for the API pages are at:

  api-site/api-ref-guides/target/docbkx/pdf/*.pdf

• The root of the API quick start is at:

  api-site/api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf

Run tests

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 checkniceness - Niceness tests
• tox -e checksyntax - Syntax checks
• tox -e checkdeletions - Verifies that no deleted files are referenced
• tox -e checkbuild - Builds the manual

To run these tests, the Tox package uses the OpenStack doc tools package.

The OpenStack doc tools require Maven for the build check.

Contribute

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 #openstack on irc.freenode.net.

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.

Bugs

File bugs on Launchpad and not through GitHub:

https://bugs.launchpad.net/openstack-api-site/

Install

To learn more about the OpenStack project, see OpenStack.