2a064c72af
When adopting oslo.versionedobject, we found that obj_name has been used as a function for VersionedObject class. Unfortunately, in senlin database, we have 'obj_name' column (property) for events. This is making the event objects very difficult to be serialized/deserialized. This patch renames the 'obj_id', 'obj_name', 'obj_type' fields to 'oid', 'oname', and 'otype' respectively. Change-Id: Idcdd979946b0e5289c4b42d2a322324d011954e0
Building the developer docs
For user and admin docs, go to the directory doc/docbkx.
Dependencies
You'll need to install python Sphinx package and oslosphinx package:
sudo pip install sphinx oslosphinxIf you are using the virtualenv you'll need to install them in the virtualenv.
Get Help
Just type make to get help:
makeIt will list available build targets.
Build Doc
To build the man pages:
make manTo build the developer documentation as HTML:
make htmlType make for more formats.
Test Doc
If you modify doc files, you can type:
make doctestto check whether the format has problem.