9a5395f1b2
Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
39 lines
530 B
Plaintext
39 lines
530 B
Plaintext
*.pyc
|
|
*.sw?
|
|
*.egg/
|
|
vendor
|
|
.ksl-venv
|
|
.venv
|
|
.update-venv/
|
|
.tox
|
|
keystone.egg-info/
|
|
*.log
|
|
.coverage
|
|
api-ref/build
|
|
coverage.xml
|
|
cover/*
|
|
covhtml
|
|
pep8.txt
|
|
nosetests.xml
|
|
doc/build
|
|
.DS_Store
|
|
doc/source/api
|
|
doc/source/modules.rst
|
|
ChangeLog
|
|
AUTHORS
|
|
build/
|
|
dist/
|
|
etc/keystone.conf
|
|
etc/logging.conf
|
|
etc/keystone/
|
|
keystone/tests/tmp/
|
|
.project
|
|
.pydevproject
|
|
keystone/locale/*/LC_MESSAGES/*.mo
|
|
.testrepository/
|
|
*.db
|
|
# Files created by releasenotes build
|
|
releasenotes/build
|
|
# sample config included in docs
|
|
doc/source/_static/keystone.conf.sample
|