nova/doc
sateesh 4e179b4fa9 Implementation of blueprint hypervisor-vmware-vsphere-support. (Link to blueprint: https://blueprints.launchpad.net/nova/+spec/hypervisor-vmware-vsphere-support)
Adds support for hypervisor vmware ESX/ESXi server in OpenStack (Nova).

Key features included are,
1) Support for FLAT and VLAN networking model
2) Support for Guest console access through VMware vmrc
3) Integrated with Glance service for image storage and retrival


Documentation: A readme file at "doc/source/vmwareapi_readme.rst" encapsulates configuration/installation instructions required to use this module/feature.
2011-03-24 22:43:46 +00:00
..
build Removing pesky DS_Store files too. Begone. 2011-02-21 14:35:30 -06:00
ext execvp: fix docs 2011-03-09 17:22:54 -05:00
source Implementation of blueprint hypervisor-vmware-vsphere-support. (Link to blueprint: https://blueprints.launchpad.net/nova/+spec/hypervisor-vmware-vsphere-support) 2011-03-24 22:43:46 +00:00
.autogenerated adding new source docs 2011-03-02 16:57:56 -08:00
.gitignore Updated sphinx layout to a two-dir layout like swift. 2010-07-24 18:06:22 -07:00
find_autodoc_modules.sh quieter doc building (less warnings). 2010-11-07 14:58:02 -05:00
generate_autodoc_index.sh Cleanups to doc process. 2010-11-07 15:14:58 -05:00
Makefile Since we're autodocumenting from a sphinx ext, we can scrap it in Makefile. 2010-11-07 18:18:04 -05:00
README.rst Merge lp:~termie/nova/trunkdoc (via patch, since bzr though it was already merged) 2010-11-07 14:51:40 -05:00

Building the docs

It is really easy. You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the nova modules.

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst
  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!