Metapensiero-sphinx-autodoc-sa

~~~~~~~~~~~~~~~~

* New option ``autodoc_sa_prettifier_options`` to pass arbitrary keyword options to the
prettifier function

~~~~~~~~~~~~~~~~

* Replace the dynamic argument placeholders injected by SA with their literal values, leaving
the developer's explicit bindparams alone

~~~~~~~~~~~~~~~~

* Handle also the `pg_query`__ SQL prettifier

* New options, ``autodoc_sa_prettifier`` and ``autodoc_pygments_lang``

__ https://pypi.python.org/pypi/pg_query

~~~~~~~~~~~~~~~~

* Minor tweak, no externally visible changes

~~~~~~~~~~~~~~~~

* First release on PyPI

~~~~~~~~~~~~~~~~

* Polished, tested and extended to support class' attributes as well

* Extracted from metapensiero.sphinx.patchdb


-*- mode: makefile-gmake; coding: utf-8 -*-
:Project: metapensiero.sphinx.autodoc_sa -- Autodoc extension to pretty print canned SA queries
:Created: Sat 14 Jan 2017 10:34:19 CET
:Author: Lele Gaifax <lelemetapensiero.it>
:License: GNU General Public License version 3 or later
:Copyright: © 2017 Lele Gaifax


PYTHON := $(BINDIR)python
BUMPER := $(BINDIR)bump_version
VERSION_TXT := version.txt
VERSION = $(shell cat $(VERSION_TXT))

help::
printf "\nRelease management\n"
printf "==================\n\n"

.PHONY: assert-clean-tree
assert-clean-tree:
(test -z "$(shell git status -s --untracked=no)" || \
(echo "UNCOMMITTED STAFF" && false))

.PHONY: assert-master-branch
assert-master-branch:
(test "$(shell git rev-parse --abbrev-ref HEAD)" = "master" || \
(echo "NOT IN MASTER BRANCH" && false))

help::
printf "release\n\tBump version number\n"

.PHONY: release
release: assert-master-branch assert-clean-tree
$(BUMPER) $(VERSION_TXT)
echo ">>>"
echo ">>> Do your duties (update CHANGES.rst for example), then"
echo ">>> execute “make tag-release”."
echo ">>>"

help::
printf "tag-release\n\tComplete the release tagging the working tree\n"

.PHONY: tag-release
tag-release: assert-master-branch check-release-date check-long-description-markup
git commit -a -m "Release $(VERSION)"
git tag -a -m "Version $(VERSION)" v$(VERSION)

.PHONY: check-long-description-markup
check-long-description-markup:
$(PYTHON) setup.py check -r -s

.PHONY: check-release-date
check-release-date:
fgrep -q "$(VERSION) ($(shell date --iso-8601))" CHANGES.rst \
|| (echo "ERROR: release date of version $(VERSION) not set in CHANGES.rst"; exit 1)

help::
printf "pypi-upload\n\tUpload the source distribution to PyPI\n"

.PHONY: pypi-upload
pypi-upload: assert-master-branch assert-clean-tree
$(PYTHON) setup.py sdist upload

help::
printf "publish\n\tUpload to PyPI, push changes and tags to the remote repo\n"

.PHONY: publish
publish: pypi-upload
git push
git push --tags