Merge "Rearranges to create new Compute API Guide"
This commit is contained in:
commit
80779e2806
|
@ -30,6 +30,7 @@ covhtml
|
|||
dist/*
|
||||
doc/source/api/*
|
||||
doc/build/*
|
||||
api-guide/build/*
|
||||
etc/nova/nova.conf.sample
|
||||
instances
|
||||
keeper
|
||||
|
|
|
@ -1,5 +1,14 @@
|
|||
OpenStack Nova Documentation README
|
||||
===================================
|
||||
|
||||
See the "Building the Documentation" section of
|
||||
Both contributor developer documentation and
|
||||
REST API documentation are sourced here.
|
||||
|
||||
Contributor developer docs are built to:
|
||||
http://docs.openstack.org/developer/nova/
|
||||
|
||||
API guide docs are built to:
|
||||
http://developer.openstack.org/api-guide/compute/
|
||||
|
||||
For more details, see the "Building the Documentation" section of
|
||||
doc/source/development.environment.rst.
|
||||
|
|
|
@ -58,17 +58,14 @@ Changes to the Compute API post v2.1 are made using microversions. You can see a
|
|||
|
||||
api_microversion_history
|
||||
|
||||
We also have a local copy of the v2 docs:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
v2/index
|
||||
We also publish end-user API docs as an API Guide.
|
||||
|
||||
* `Compute API Guide`_
|
||||
|
||||
.. _`v2.1 (CURRENT)`: http://developer.openstack.org/api-ref-compute-v2.1.html
|
||||
.. _`v2 (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2.html
|
||||
.. _`v2 extensions (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2-ext.html
|
||||
.. _`Compute API Guide`: http://developer.openstack.org/api-guide/compute/
|
||||
|
||||
There was a session on the v2.1 API at the Liberty summit which you can watch
|
||||
`here <https://www.openstack.org/summit/vancouver-2015/summit-videos/presentation/introduction-of-a-new-nova-rest-api-why-we-need-to-use-nova-v2-1-api>`_.
|
||||
|
|
|
@ -196,6 +196,11 @@ all_files = 1
|
|||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
|
||||
[build_apiguide]
|
||||
all_files = 1
|
||||
build-dir = api-guide/build
|
||||
source-dir = api-guide/source
|
||||
|
||||
[egg_info]
|
||||
tag_build =
|
||||
tag_date = 0
|
||||
|
|
|
@ -22,6 +22,7 @@ testresources>=0.2.4
|
|||
testtools>=1.4.0
|
||||
tempest-lib>=0.10.0
|
||||
bandit>=0.13.2
|
||||
openstackdocstheme>=1.0.3
|
||||
|
||||
# vmwareapi driver specific dependencies
|
||||
oslo.vmware>=1.16.0 # Apache-2.0
|
||||
|
|
9
tox.ini
9
tox.ini
|
@ -104,10 +104,17 @@ commands = {posargs}
|
|||
|
||||
[testenv:docs]
|
||||
commands =
|
||||
rm -rf doc/source/api doc/build
|
||||
rm -rf doc/source/api doc/build api-guide/build
|
||||
python setup.py build_sphinx
|
||||
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
|
||||
oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
|
||||
sphinx-build -b html api-guide/source api-guide/build
|
||||
|
||||
[testenv:api-guide]
|
||||
# This environment is called from CI scripts to test and publish
|
||||
# the API Guide to developer.openstack.org.
|
||||
commands =
|
||||
sphinx-build -b html -d api-guide/build/doctrees api-guide/source api-guide/build
|
||||
|
||||
[testenv:docs-constraints]
|
||||
install_command = {[testenv:common-constraints]install_command}
|
||||
|
|
Loading…
Reference in New Issue