diff options
| author | Ask Solem <ask@celeryproject.org> | 2016-04-08 13:47:43 -0700 |
|---|---|---|
| committer | Ask Solem <ask@celeryproject.org> | 2016-04-08 14:59:05 -0700 |
| commit | 664b69148726b25d3d33646084f22c34078b248f (patch) | |
| tree | 4006d3bfb4fa2cdb1417656e2059360cfbcc31f8 /docs | |
| parent | 1e788eede3a8345b4e0f38acf9fef113a6a75a63 (diff) | |
| download | py-amqp-664b69148726b25d3d33646084f22c34078b248f.tar.gz | |
[dist] Use apicheck from sphinx_celery
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 5 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/reference/amqp.spec.rst | 11 | ||||
| -rw-r--r-- | docs/reference/index.rst | 1 |
4 files changed, 19 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile index 14b39e4..8825377 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -47,6 +47,7 @@ help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " apicheck to verify that all modules are present in autodoc" .PHONY: clean clean: @@ -210,6 +211,10 @@ coverage: @echo "Testing of coverage in the sources finished, look at the " \ "results in $(BUILDDIR)/coverage/python.txt." +.PHONY: apicheck +apicheck: + $(SPHINXBUILD) -b apicheck $(ALLSPHINXOPTS) $(BUILDDIR)/apicheck + .PHONY: xml xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml diff --git a/docs/conf.py b/docs/conf.py index 8c541d8..73f0e52 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,4 +21,6 @@ globals().update(conf.build_config( html_prepend_sidebars=['sidebardonations.html'], extra_extensions=[], include_intersphinx={'python', 'sphinx'}, + apicheck_package='amqp', + apicheck_ignore_modules=['amqp'], )) diff --git a/docs/reference/amqp.spec.rst b/docs/reference/amqp.spec.rst new file mode 100644 index 0000000..41b122c --- /dev/null +++ b/docs/reference/amqp.spec.rst @@ -0,0 +1,11 @@ +===================================================== + amqp.spec +===================================================== + +.. contents:: + :local: +.. currentmodule:: amqp.spec + +.. automodule:: amqp.spec + :members: + :undoc-members: diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 3a19812..1c12869 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -19,5 +19,6 @@ amqp.method_framing amqp.protocol amqp.serialization + amqp.spec amqp.utils amqp.five |