Cloud API Docs Plugin

Generates a XHTML and API documents.

License	Apache License, Version 2.0
Categories	Maven Build Tools
GroupId	com.rackspace.cloud.api
ArtifactId	clouddocs-maven-plugin
Last Version	2.1.4
Release Date	Apr 14, 2015
Type	maven-plugin
Description	Cloud API Docs Plugin Generates a XHTML and API documents.
Project URL	https://github.com/rackerlabs/clouddocs-maven-plugin
Source Code Management	https://github.com/rackerlabs/clouddocs-maven-plugin/tree/master

Download clouddocs-maven-plugin

Filename	Size
clouddocs-maven-plugin-2.1.4.pom
clouddocs-maven-plugin-2.1.4.jar	13 MB
clouddocs-maven-plugin-2.1.4-sources.jar	13 MB
clouddocs-maven-plugin-2.1.4-javadoc.jar	464 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.rackspace.cloud.api</groupId>
    <artifactId>clouddocs-maven-plugin</artifactId>
    <version>2.1.4</version>
</plugin>

Dependencies

compile (27)

Group / Artifact	Type	Version
com.agilejava.docbkx : docbkx-maven-plugin	jar	2.0.14
net.sf.saxon : Saxon-HE	jar	9.5.1-2
org.springframework : spring-web	jar	3.1.1.RELEASE
com.xmlcalabash : xmlcalabash	jar	1.0.13-94
org.apache.httpcomponents : httpclient	jar	4.0-alpha4
commons-logging : commons-logging-api	jar	1.1
commons-codec : commons-codec	jar	1.5
com.thaiopensource : jing	jar	20091111
org.ccil.cowan.tagsoup : tagsoup	jar	1.2.1
org.apache.maven.plugins : maven-dependency-plugin	jar	2.3
org.mockito : mockito-all	jar	1.8.5
commons-io : commons-io	jar	2.0
net.sf.docbook : docbook-xsl	zip	1.76.1
com.rackspace.apache : xerces2-xsd11	jar	2.11.2
org.apache.avalon.framework : avalon-framework-impl	jar	4.3.1
xalan : xalan	jar	2.7.0
org.apache.maven : maven-plugin-api	jar	2.0
com.agilejava.docbkx : docbkx-maven-base	jar	2.0.14
net.sf.xslthl : xslthl	jar	2.0.1
net.sf.docbook : docbook-xsl-saxon	jar	1.0.0
org.apache.xmlgraphics : fop	jar	1.0
xml-apis : xml-apis-ext	jar	1.3.04
xml-apis : xml-apis	jar	1.3.04
batik : batik-rasterizer	jar	1.6
batik : batik-swing	jar	1.6
org.apache.xmlgraphics : batik-codec	jar	1.7
org.eclipse.jgit : org.eclipse.jgit	jar	3.0.0.201306101825-r

provided (1)

Group / Artifact	Type	Version
com.rackspace.cloud.api : wadl-tools	jar	1.0.27

runtime (2)

Group / Artifact	Type	Version
xerces : xmlParserAPIs	jar	2.6.2
net.sf.offo : fop-hyph	jar	1.2

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.8.1
org.apache.maven.shared : maven-plugin-testing-harness	jar	1.0-beta-1

Project Modules

There are no modules declared in this project.

Introduction

This project is the Rackspace/OpenStack customization of the Docbkx plug-in for creating documentation artifacts for Rackspace, OpenStack, and other OpenStack projects.

Example output

Rackspace output:

• http://docs.rackspace.com/files/api/v1/cf-devguide/content/Overview-d1e70.html

OpenStack output:

• http://docs.openstack.org/user-guide/content/
• http://api.openstack.org/api-ref.html

OpenStack source files:

• https://github.com/openstack/openstack-manuals/tree/master/doc/user-guide/src
• https://github.com/openstack/api-site/tree/master/api-ref

Test changes to clouddocs-maven-plugin

Note: When you commit, be sure you are on a branch, do a single commit, and do "git review" instead of pushing.

To test changes to clouddocs-maven-plugin on your local machine:

1. Run this command to clone clouddocs-maven-plugin:

   git clone [email protected]:stackforge/clouddocs-maven-plugin.git

2. CD into the clouddocs-maven-plugin directory.

3. Edit the pom.xml file and set the version number on line #11 to include -SNAPSHOT. For example, 1.12.1-SNAPSHOT.

4. Make changes to clouddocs-maven-plugin.

5. Run this command to build clouddocs-maven-plugin locally:

   mvn clean install

6. Run this command to clone the api-site:

   git clone [email protected]:openstack/api-site.git

7. CD into the api-site directory.

8. Edit the pom.xml file and set the version number on line #42 to the same version number as in the clouddocs-maven-plugin pom.xml file. For example, 1.12.1-SNAPSHOT.

9. Run the following command to build the api-site locally:

   mvn clean generate-sources -U

   The -U switch picks up the local build of clouddocs-maven-plugin.

How Tos

• http://docs.rackspace.com/writers-guide
• http://wiki.openstack.org/Documentation/HowTo#Tools_Overview

rackspace

Rackspace public git repositories

Versions

Version
2.1.4 Apr 14, 2015
2.1.3 Sep 22, 2014
2.1.2 Jul 15, 2014
2.1.1 Jul 1, 2014
2.1.0 Jun 23, 2014
2.0.4 Jun 5, 2014
2.0.3 May 23, 2014
2.0.2 May 9, 2014
2.0.1 May 8, 2014
2.0.0 Apr 24, 2014
1.15.0 Mar 21, 2014
1.14.1 Mar 6, 2014
1.14.0 Mar 4, 2014
1.13.0 Jan 23, 2014
1.12.2 Jan 9, 2014
1.12.1 Jan 8, 2014
1.12.0 Nov 20, 2013
1.11.1 Oct 14, 2013
1.11.0 Sep 30, 2013