diff options
| author | Amrith Kumar <amrith@tesora.com> | 2016-08-17 13:27:51 -0400 |
|---|---|---|
| committer | Amrith Kumar <amrith@tesora.com> | 2016-08-17 17:46:41 -0400 |
| commit | 3b0d1ea25d06c5b58e895da7b1003ad8fc83e12e (patch) | |
| tree | be0524a3a98c833e3c6b4c66483c35e4cbc08afe /CONTRIBUTING.rst | |
| parent | 27a076f6d6dee97d25f60457f1450e1942c2c4e8 (diff) | |
| download | trove-3b0d1ea25d06c5b58e895da7b1003ad8fc83e12e.tar.gz | |
Adds the api-ref migrated RST + YAML files
With this email[0], you must migrate API reference docs into RST. The
conf.py and the tox environment are also cribbed from nova.
Still need to retain the install_command in tox.ini, otherwise the
api-ref job fails.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Co-Authored-By: Anne Gentle <agentle@cisco.com>
Co-Authored-By: Amrith Kumar <amrith@tesora.com>
Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 55 |
1 files changed, 5 insertions, 50 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f442a8ce..a9864b8b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -143,59 +143,14 @@ process. Trove Documentation =================== -This repository also contains the following OpenStack manual: +This repository also contains the Database Services API Reference. +To build the API reference, run:: -* Database Services API Reference + $ tox -e api-ref -Prerequisites for Building the Documentation --------------------------------------------- -`Apache Maven <http://maven.apache.org/>`_ must be installed to build the -documentation. +The generated documentation is found:: -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 ``apidocs`` directory. - -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 apidocs - mvn clean generate-sources - -The generated PDF documentation file is:: - - apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf - -The root of the generated HTML documentation is:: - - apidocs/target/docbkx/webhelp/cdb-devguide/content/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 -<https://github.com/openstack/openstack-doc-tools>`_ for execution of -these tests. openstack-doc-tools has a requirement on maven for the -build check. + api-ref/html/index.html Testing ======= |