Skip to content

Commit

Permalink
[dist] Use apicheck from sphinx_celery
Browse files Browse the repository at this point in the history
  • Loading branch information
ask committed Apr 8, 2016
1 parent e5e631c commit a25b777
Show file tree
Hide file tree
Showing 20 changed files with 173 additions and 81 deletions.
17 changes: 7 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,17 @@ SPHINX2RST="sphinx2rst"
SPHINX_HTMLDIR = "${SPHINX_BUILDDIR}/html"

html:
(cd "$(SPHINX_DIR)"; make html)
(cd "$(SPHINX_DIR)"; $(MAKE) html)
mv "$(SPHINX_HTMLDIR)" Documentation

docsclean:
-rm -rf "$(SPHINX_BUILDDIR)"

htmlclean:
(cd "$(SPHINX_DIR)"; make clean)
(cd "$(SPHINX_DIR)"; $(MAKE) clean)

apicheck:
extra/release/doc4allmods kombu

indexcheck:
extra/release/verify-reference-index.sh

configcheck:
PYTHONPATH=. $(PYTHON) extra/release/verify_config_reference.py $(CONFIGREF_SRC)
(cd "$(SPHINX_DIR)"; $(MAKE) apicheck)

flakecheck:
flake8 kombu
Expand Down Expand Up @@ -68,6 +62,9 @@ gitclean:
gitcleanforce:
git clean -xdf

distcheck: flakecheck apicheck indexcheck configcheck readmecheck test gitclean
tox: removepyc
tox

distcheck: flakecheck apicheck readmecheck test gitclean

dist: readme docsclean gitcleanforce removepyc
5 changes: 5 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,15 @@
html_prepend_sidebars=['sidebardonations.html'],
extra_extensions=[],
configure_django_settings={'DEBUG': False},
apicheck_ignore_modules=[
'kombu.entity',
'kombu.messaging',
'kombu.transport.django.management',
'kombu.transport.django.management.commands',
r'kombu.transport.django.migrations.*',
r'kombu.transport.django.south_migrations.*',
'kombu.async.aws.ext',
'kombu.async.aws.sqs.ext',
'kombu.transport.qpid_patches',
],
))
11 changes: 11 additions & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,22 @@
kombu.compression
kombu.pools
kombu.abstract
kombu.resource
kombu.syn
kombu.async
kombu.async.hub
kombu.async.semaphore
kombu.async.timer
kombu.async.debug
kombu.async.http
kombu.async.http.base
kombu.async.http.curl
kombu.async.aws
kombu.async.aws.connection
kombu.async.aws.sqs
kombu.async.aws.sqs.connection
kombu.async.aws.sqs.message
kombu.async.aws.sqs.queue
kombu.transport
kombu.transport.pyamqp
kombu.transport.librabbitmq
Expand Down Expand Up @@ -61,6 +71,7 @@
kombu.utils.debug
kombu.utils.encoding
kombu.utils.functional
kombu.utils.json
kombu.utils.url
kombu.utils.text
kombu.utils.amq_manager
Expand Down
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.connection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Amazon AWS Connection - kombu.async.aws.connection
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws.connection

.. automodule:: kombu.async.aws.connection
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Async Amazon AWS Client - kombu.async.aws
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws

.. automodule:: kombu.async.aws
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.sqs.connection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
SQS Connection - kombu.async.aws.sqs.connection
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws.sqs.connection

.. automodule:: kombu.async.aws.sqs.connection
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.sqs.message.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
SQS Messages - kombu.async.aws.sqs.message
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws.sqs.message

.. automodule:: kombu.async.aws.sqs.message
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.sqs.queue.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
SQS Queues - kombu.async.aws.sqs.queue
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws.sqs.queue

.. automodule:: kombu.async.aws.sqs.queue
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.aws.sqs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Async Amazon SQS Client - kombu.async.aws.sqs
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.aws.sqs

.. automodule:: kombu.async.aws.sqs
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.http.base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Async HTTP Client Interface - kombu.async.http.base
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.http.base

.. automodule:: kombu.async.http.base
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.http.curl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Async pyCurl HTTP Client - kombu.async.http.curl
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.http.curl

.. automodule:: kombu.async.http.curl
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.async.http.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Async HTTP Client - kombu.async.http
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.async.http

.. automodule:: kombu.async.http
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.resource.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
Resource Management - kombu.resource
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.resource

.. automodule:: kombu.resource
:members:
:undoc-members:
11 changes: 11 additions & 0 deletions docs/reference/kombu.utils.json.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==========================================================
JSON Utilities - kombu.utils.json
==========================================================

.. contents::
:local:
.. currentmodule:: kombu.utils.json

.. automodule:: kombu.utils.json
:members:
:undoc-members:
40 changes: 0 additions & 40 deletions extra/release/doc4allmods

This file was deleted.

3 changes: 0 additions & 3 deletions extra/release/removepyc.sh

This file was deleted.

19 changes: 0 additions & 19 deletions extra/release/verify-reference-index.sh

This file was deleted.

2 changes: 1 addition & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx_celery
sphinx_celery>=1.1
Django
librabbitmq
-r extras/mongodb.txt
25 changes: 17 additions & 8 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = 2.7,3.4,3.5,pypy,pypy3
envlist = 2.7,pypy,3.4,3.5,pypy3,flake8,flakeplus,apicheck

[testenv]
sitepackages = False
Expand All @@ -11,25 +11,34 @@ deps=
2.7,pypy,jython: -r{toxinidir}/requirements/test-ci.txt
3.3,3.4,3.5,pypy3: -r{toxinidir}/requirements/test-ci3.txt

apicheck,linkcheck: -r{toxinidir}/requirements/docs.txt
flake8,flakeplus: -r{toxinidir}/requirements/pkgutils.txt

commands = pip install -U -r{toxinidir}/requirements/dev.txt
nosetests -vdsx kombu.tests \
--with-coverage --cover-inclusive --cover-erase []

basepython =
2.7: python2.7
2.7,flakeplus,flake8,apicheck,linkcheck: python2.7
3.3: python3.3
3.4: python3.4
3.5: python3.5
pypy: pypy
pypy3: pypy3
jython: jython
commands = {toxinidir}/extra/release/removepyc.sh {toxinidir}
pip install -U -r{toxinidir}/requirements/dev.txt
nosetests -vdsx kombu.tests \
--with-coverage --cover-inclusive --cover-erase []

[testenv:apicheck]
commands =
sphinx-build -W -b apicheck -d {envtmpdir}/doctrees docs docs/_build/apicheck

[testenv:linkcheck]
commands =
sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/linkcheck

[testenv:flake8]
deps = -r{toxinidir}/requirements/pkgutils.txt
commands =
flake8 {toxinidir}/kombu

[testenv:flakeplus]
deps = -r{toxinidir}/requirements/pkgutils.txt
commands =
flakeplus --2.7 {toxinidir}/kombu

0 comments on commit a25b777

Please sign in to comment.