openstack-attic/compute-api
Code Issues Proposed changes

Setup for openstack-doc-tools

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

Change-Id: I8a69f2bbee0060b96a30ecd6f9a88d1678194bea
This commit is contained in:
Andreas Jaeger 2014-01-07 20:21:38 +01:00
parent 2d1ac877e5
commit 688660bbe5
4 changed files with 100 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.gitignore vendored
View File

@ -1,5 +1,15 @@
.DS_Store?
# Build results
target/
# Testenvironment
.tox
# Editors
*~
.*.swp
.bak
# Per-user NetBeans files
nbactions.xml

63
README.rst
View File

@ -1,9 +1,66 @@
This repository contains the RESTful API information for the OpenStack Compute project, also known as Nova. The Nova project provides open source cloud management and orchestration services.
Compute API
+++++++++++
This repository contains the RESTful API information for the OpenStack
Compute project, also known as Nova. The Nova project provides open
source cloud management and orchestration services.
Prerequisites
=============
`Apache Maven <http://maven.apache.org/>`_ 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
========
The manuals are in the ``incubation``, ``openstack-compute-api-1.0``
and ``openstack-compute-api-2`` directories.
To build a specific guide, look for a ``pom.xml`` file within a subdirectory,
then run the ``mvn`` command in that directory. For example::
cd openstack-compute-api-2
mvn clean generate-sources
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
<https://github.com/openstack/openstack-doc-tools>`_ for execution of
these tests. openstack-doc-tools has a requirement on maven for the
build check.
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.
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.
Installing
==========
Refer to http://docs.openstack.org to learn more about installing an OpenStack Compute server that can respond to these API commands.
Refer to http://docs.openstack.org to learn more about installing an
OpenStack Compute server that can respond to these API commands.

1
test-requirements.txt Normal file
View File

@ -0,0 +1 @@
openstack-doc-tools

29
tox.ini Normal file
View File

@ -0,0 +1,29 @@
[tox]
minversion = 1.6
envlist = checkniceness,checksyntax,checkdeletions,checkbuild
skipsdist = True
[testenv]
setenv =
VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
deps = -r{toxinidir}/test-requirements.txt
[testenv:venv]
commands = {posargs}
[testenv:checkniceness]
commands = openstack-doc-test --api-site --check-niceness {posargs}
[testenv:checksyntax]
commands = openstack-doc-test --api-site --check-syntax {posargs}
[testenv:checkdeletions]
commands = openstack-doc-test --api-site --check-deletions {posargs}
[testenv:checkbuild]
# ignore directories incubation and openstack-compute-api-1.0, these are
# not published
commands = openstack-doc-test --api-site --check-build --ignore-dir=incubation --ignore-dir=openstack-compute-api-1.0 {posargs}