Add a wadl target to the documentation
Thanks to sphinxcontrib-docbookrestapi, the documentation for the REST API can be automatically generated. Add a target to do this. Change-Id: I9dda41bc00160bf1be1e275d9ac94a3a53571688
This commit is contained in:
parent
2b7cd6778d
commit
9a14370266
@ -37,6 +37,7 @@ help:
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " wadl to build a WADL file for api.openstack.org"
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
@ -50,6 +51,11 @@ html: check-dependencies
|
||||
check-dependencies:
|
||||
@python -c 'import sphinxcontrib.autohttp.flask' >/dev/null 2>&1 || (echo "ERROR: Missing Sphinx dependencies. Run: pip install sphinxcontrib-httpdomain" && exit 1)
|
||||
|
||||
wadl:
|
||||
$(SPHINXBUILD) -b docbook $(ALLSPHINXOPTS) $(BUILDDIR)/wadl
|
||||
@echo
|
||||
@echo "Build finished. The WADL pages are in $(BUILDDIR)/wadl."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
|
@ -151,6 +151,7 @@ extensions = [
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinxcontrib.pecanwsme.rest',
|
||||
'oslo.sphinx',
|
||||
'sphinxcontrib.docbookrestapi.setup'
|
||||
]
|
||||
|
||||
wsme_protocols = ['restjson', 'restxml']
|
||||
|
@ -1,3 +1,5 @@
|
||||
.. docbookrestapi
|
||||
|
||||
============
|
||||
V2 Web API
|
||||
============
|
||||
|
@ -16,6 +16,7 @@ docutils==0.9.1
|
||||
oslo.sphinx
|
||||
python-subunit
|
||||
sphinx>=1.1.2,<1.2
|
||||
sphinxcontrib-docbookrestapi
|
||||
sphinxcontrib-httpdomain
|
||||
sphinxcontrib-pecanwsme>=0.5
|
||||
testrepository>=0.0.17
|
||||
|
Loading…
Reference in New Issue
Block a user