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
45 lines
1.3 KiB
Plaintext
45 lines
1.3 KiB
Plaintext
# The order of packages is significant, because pip processes them in the order
|
|
# of appearance. Changing the order has an impact on the overall integration
|
|
# process, which may cause wedges in the gate later.
|
|
|
|
hacking<0.11,>=0.10.0
|
|
pep257==0.7.0 # MIT License
|
|
flake8-docstrings==0.2.1.post1 # MIT
|
|
bashate>=0.2 # Apache-2.0
|
|
os-testr>=0.4.1 # Apache-2.0
|
|
|
|
# Include drivers for opportunistic testing.
|
|
oslo.db[fixtures,mysql,postgresql]>=4.1.0 # Apache-2.0
|
|
|
|
# computes code coverage percentages
|
|
coverage>=3.6 # Apache-2.0
|
|
# fixture stubbing
|
|
fixtures<2.0,>=1.3.1 # Apache-2.0/BSD
|
|
# xml parsing
|
|
lxml>=2.3 # BSD
|
|
# mock object framework
|
|
mock>=1.2 # BSD
|
|
oslotest>=1.10.0 # Apache-2.0
|
|
# required to build documentation
|
|
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
|
|
os-api-ref>=0.1.0 # Apache-2.0
|
|
# test wsgi apps without starting an http server
|
|
WebTest>=2.0 # MIT
|
|
|
|
# mox was removed in favor of mock. We should not re-enable this module. See
|
|
# discussion: http://lists.openstack.org/pipermail/openstack-dev/2013-July/012484.html
|
|
#mox>=0.5.3
|
|
|
|
python-subunit>=0.0.18 # Apache-2.0/BSD
|
|
testrepository>=0.0.18 # Apache-2.0/BSD
|
|
testtools>=1.4.0 # MIT
|
|
|
|
# For documentation
|
|
oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
|
|
reno>=1.6.2 # Apache2
|
|
|
|
tempest>=11.0.0 # Apache-2.0
|
|
|
|
# Functional tests.
|
|
requests>=2.10.0 # Apache-2.0
|