Merge "Add a wadl target to the documentation"
This commit is contained in:
commit
369bb0fb64
@ -37,6 +37,7 @@ help:
|
|||||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||||
@echo " linkcheck to check all external links for integrity"
|
@echo " linkcheck to check all external links for integrity"
|
||||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
@echo " wadl to build a WADL file for api.openstack.org"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
-rm -rf $(BUILDDIR)/*
|
-rm -rf $(BUILDDIR)/*
|
||||||
@ -50,6 +51,11 @@ html: check-dependencies
|
|||||||
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)
|
@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:
|
dirhtml:
|
||||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
@echo
|
@echo
|
||||||
|
@ -151,6 +151,7 @@ extensions = [
|
|||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'sphinxcontrib.pecanwsme.rest',
|
'sphinxcontrib.pecanwsme.rest',
|
||||||
'oslo.sphinx',
|
'oslo.sphinx',
|
||||||
|
'sphinxcontrib.docbookrestapi.setup'
|
||||||
]
|
]
|
||||||
|
|
||||||
wsme_protocols = ['restjson', 'restxml']
|
wsme_protocols = ['restjson', 'restxml']
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. docbookrestapi
|
||||||
|
|
||||||
============
|
============
|
||||||
V2 Web API
|
V2 Web API
|
||||||
============
|
============
|
||||||
|
@ -16,6 +16,7 @@ docutils==0.9.1
|
|||||||
oslo.sphinx
|
oslo.sphinx
|
||||||
python-subunit
|
python-subunit
|
||||||
sphinx>=1.1.2,<1.2
|
sphinx>=1.1.2,<1.2
|
||||||
|
sphinxcontrib-docbookrestapi
|
||||||
sphinxcontrib-httpdomain
|
sphinxcontrib-httpdomain
|
||||||
sphinxcontrib-pecanwsme>=0.5
|
sphinxcontrib-pecanwsme>=0.5
|
||||||
testrepository>=0.0.17
|
testrepository>=0.0.17
|
||||||
|
Loading…
x
Reference in New Issue
Block a user