Setup for openstack-doc-tools

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

Change-Id: I54cf9443eb154f3b06d0412cf5641ffb5254579b
changes/41/65341/1
Andreas Jaeger 9 years ago
parent fa69275135
commit f0af2655aa
  1. 11
      .gitignore
  2. 40
      README.rst
  3. 1
      test-requirements.txt
  4. 27
      tox.ini

11
.gitignore vendored

@ -1,5 +1,14 @@
*.swp
# Build results
target/
openstack-identity-api/v3/identity-api-v3.xml
# NetBeans user-specific build actions
nbactions.xml
# Testenvironment
.tox
# Editors
*~
.*.swp
.bak

@ -1,7 +1,14 @@
This repository contains the RESTful API information for the OpenStack Identity Service, also known as the Keystone project. The Keystone project provides authentication for OpenStack services, with plans to also provide authorization.
Identiy Service API
+++++++++++++++++++
This repository contains the RESTful API information for the OpenStack
Identity Service, also known as the Keystone project. The Keystone
project provides authentication for OpenStack services, with plans to
also provide authorization.
Building v2.0 Docs
==================
Build these docs using the same procedure as documented for the `openstack-manuals` project: https://github.com/openstack/openstack-manuals
In short, with Maven 3::
@ -23,10 +30,37 @@ To build the docs:
./preprocess.sh
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://keystone.openstack.org to learn more about installing an OpenStack Identity Service server that can respond to these API commands.
Refer to http://keystone.openstack.org to learn more about installing
an OpenStack Identity Service server that can respond to these API
commands.

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

@ -0,0 +1,27 @@
[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]
commands = openstack-doc-test --api-site --check-build {posargs}
Loading…
Cancel
Save