openstack/placement
Code Issues Proposed changes

clean up api_samples documentation

Browse Source 
the documentation for API samples was very misleading,
and hard to point people at what to do to add new samples.
Bring this more in line with reality.

Change-Id: I52da343d317cc77e5df30815f3f3721c2634585b
This commit is contained in:
Sean Dague 2013-01-25 11:51:15 -05:00
parent 4e618e1014
commit 24c782ce60
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
nova/tests/integrated/api_samples/README.rst
View File

@ -1,11 +1,21 @@
Api Samples
===========
Samples in this directory are automatically generated from the api samples
integration tests. To regenerate the samples, simply set GENERATE_SAMPLES
in the environment before running the tests. For example:
This part of the tree contains templates for API samples. The
documentation in doc/api_samples is completely autogenerated from the
tests in this directory.
To add a new api sample, add tests for the common passing and failing
cases in this directory for your extension, and modify test_samples.py
for your tests. There should be both JSON and XML tests included.
Then run the following command:
GENERATE_SAMPLES=True tox -epy27 nova.tests.integrated
Which will create the files on doc/api_samples.
If new tests are added or the .tpl files are changed due to bug fixes, the
samples should be regenerated so they are in sync with the templates.
samples must be regenerated so they are in sync with the templates, as
there is an additional test which reloads the documentation and
ensures that it's in sync.