Andreas Jaeger a0194a51d8 Setup for openstack-doc-tools

Setup repository so that we can gate using the openstack-doc-tools
tools. Update documentation with details.

Change-Id: I8c0dd9131d45f1711d2b1c1916b2c668c6827e1a

2014-01-09 20:14:32 +01:00

2.1 KiB

Raw Blame History

Netconn API

This repository contains the RESTful API information for the OpenStack Network Connectivity project, also known as Neutron. The Neutron project provides open source network connectivity to OpenStack Compute, the project named Nova.

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Building

To build:

cd v2.0
mvn clean generate-sources

The generated PDF documentation file is:

v2.0/target/docbkx/webhelp/openstack-network/openstack-network.pdf

The root of the generated HTML documentation is:

v2.0/target/docbkx/webhelp/openstack-network/index.html

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 checkniceness - to run the niceness tests * tox -e checksyntax - to run syntax checks * tox -e checkdeletions - to check that no deleted files are referenced * tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.

2.1 KiB Raw Blame History