neutron/doc/source/docbkx/docbkx-example
Brad Hall 559aedc3d9 Merge from launchpad quantum/diablo branch:
merge salv's fix to remove keystone middleware: lp855151
  one more 202->200 from tyler
  merge tylers additional 202 -> 200 changes
  merge additions to OVS readme describing running with multiple hosts
  merge brad's changes to make create API calls return 200, not 202
  merge unit test for showing unset attachment
  merging API docs branch
  Merge: lp:~yinliu2/quantum/bug856564
  Merge: lp:~bgh/quantum/bug850261

Change-Id: I56fe24c59f918737e57b562343c33ec6dcceac60
2011-09-23 20:17:44 -07:00
..
src/docbkx Merge from launchpad quantum/diablo branch: 2011-09-23 20:17:44 -07:00
README Merge from launchpad quantum/diablo branch: 2011-09-23 20:17:44 -07:00
pom.xml Merge from launchpad quantum/diablo branch: 2011-09-23 20:17:44 -07:00

README

README

This docbkx-example folder is provided for those who want to use the maven mojo supplied with the project to build their own documents to PDF and HTML (webhelp) format. It's intended to be a template and model. 

You can edit the src/docbkx/example.xml file using vi, emacs, or another DocBook editor. At Rackspace we use Oxygen. Both Oxygen and XML Mind offer free licenses to those working on open source project documentation.

To build the output, install Apache Maven (https://maven.apache.org/) and then run:

mvn clean generate-sources 

in the directory containing the pom.xml file. 

Feel free to ask questions of the openstack-docs team at https://launchpad.net/~openstack-doc.