eae9a2ad3f
There is currently some function duplication in Heat for schema validation. There is properties.Schema and a ParamSchema class which do mostly the same, but each with their own code. It would be good to have a common implementation for property and parameter validation with only property or parameter specific code implemented in sub-classes. The current Schema class in properties.py cannot be used in parameters.py due to cyclic import dependencies that would arise. This patch factors the Schema class and Constraint classes into their own file which can then be imported by both properties.py and parameters.py. For property schema specific code, a class PropertySchema is introduced as derived from the common Schema class. The code of the Schema and Constraint classes is unchanged except for absolutely refactoring work. In a subsequent patch, I plan to provide the code to base ParamSchema on the common Schema class. Change-Id: I833edd8fad316220f56d6727fe1e3409f8fda6ee Partial-Bug: #1230229 |
||
|---|---|---|
| .. | ||
| 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 oslo-sphinx package:
sudo pip install sphinx oslo-sphinxIf 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.