7fbdb1260a
project id can be used to identify or tag which project the resources belong to. The project id can be found in cfn pseudo param AWS::StackId, but when we switch to hot, OS::stack_id is a pure stack id, no project info in it. So we add OS::project_id to meet the similar scenario requirements. Change-Id: I3db9db7c59cfa0ff3005a97cd0cb7962928598ab |
||
---|---|---|
.. | ||
docbkx | ||
source | ||
.gitignore | ||
Makefile | ||
README.rst |
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 oslosphinx
If you are using the virtualenv you'll need to install them in the virtualenv.
Get Help
Just type make to get help:
make
It will list available build targets.
Build Doc
To build the man pages:
make man
To build the developer documentation as HTML:
make html
Type make for more formats.
Test Doc
If you modify doc files, you can type:
make doctest
to check whether the format has problem.