psycopg2/doc/Makefile

.PHONY: env help clean html doctest

docs: html

check: doctest

# The environment is currently required to build the documentation.
# It is not clean by 'make clean'

PYTHON := python$(PYTHON_VERSION)
PYTHON_VERSION ?= $(shell $(PYTHON) -c 'import sys; print ("%d.%d" % sys.version_info[:2])')

SPHINXBUILD ?= $$(pwd)/env/bin/sphinx-build
SPHOPTS = SPHINXBUILD=$(SPHINXBUILD)

html: src/sqlstate_errors.rst
	$(MAKE) PYTHON=$(PYTHON) -C .. package
	$(MAKE) $(SPHOPTS) -C src $@
	cp -r src/_build/html .

src/sqlstate_errors.rst: ../psycopg/sqlstate_errors.h
	env/bin/python src/tools/make_sqlstate_docs.py $< > $@

doctest:
	$(MAKE) PYTHON=$(PYTHON) -C .. package
	$(MAKE) $(SPHOPTS) -C src $@

upload:
	# this command requires ssh configured to the proper target
	tar czf - -C html . | ssh psycoweb tar xzvf - -C docs/current

clean:
	$(MAKE) $(SPHOPTS) -C src $@
	rm -rf html src/sqlstate_errors.rst

env: requirements.txt
	virtualenv -p $(PYTHON) env
	./env/bin/pip install -r requirements.txt
	echo "$$(pwd)/../build/lib.$(PYTHON_VERSION)" \
		> env/lib/python$(PYTHON_VERSION)/site-packages/psycopg.pth
Dropped text docs generation 2019-02-17 03:48:33 +03:00			`.PHONY: env help clean html doctest`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
Dropped text docs generation 2019-02-17 03:48:33 +03:00			`docs: html`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
Added 'make check' target to docs. 2010-02-14 08:01:00 +03:00			`check: doctest`

Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`# The environment is currently required to build the documentation.`
			`# It is not clean by 'make clean'`

Docs build process and docs cleaned up 2015-04-28 11:30:59 +03:00			`PYTHON := python$(PYTHON_VERSION)`
			`PYTHON_VERSION ?= $(shell $(PYTHON) -c 'import sys; print ("%d.%d" % sys.version_info[:2])')`

Allow SPHINXBUILD on command line 2018-10-07 14:55:11 +03:00			`SPHINXBUILD ?= $$(pwd)/env/bin/sphinx-build`
Allow building docs with Python 3 Use a .pth file to simplify finding the just-built psycopg package into the docs building env. 2019-02-17 04:12:39 +03:00			`SPHOPTS = SPHINXBUILD=$(SPHINXBUILD)`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
Added table of sqlstate exceptions in the docs Note that the column-spanning cells break text docs. I don't think anybody cares about them, so going to drop them. 2019-02-17 03:41:29 +03:00			`html: src/sqlstate_errors.rst`
Docs build process and docs cleaned up 2015-04-28 11:30:59 +03:00			`$(MAKE) PYTHON=$(PYTHON) -C .. package`
			`$(MAKE) $(SPHOPTS) -C src $@`
Documentation dir reordered. 2010-02-14 19:11:01 +03:00			`cp -r src/_build/html .`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
Added table of sqlstate exceptions in the docs Note that the column-spanning cells break text docs. I don't think anybody cares about them, so going to drop them. 2019-02-17 03:41:29 +03:00			`src/sqlstate_errors.rst: ../psycopg/sqlstate_errors.h`
Allow building docs with Python 3 Use a .pth file to simplify finding the just-built psycopg package into the docs building env. 2019-02-17 04:12:39 +03:00			`env/bin/python src/tools/make_sqlstate_docs.py $< > $@`
Added table of sqlstate exceptions in the docs Note that the column-spanning cells break text docs. I don't think anybody cares about them, so going to drop them. 2019-02-17 03:41:29 +03:00
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00			`doctest:`
Docs build process and docs cleaned up 2015-04-28 11:30:59 +03:00			`$(MAKE) PYTHON=$(PYTHON) -C .. package`
			`$(MAKE) $(SPHOPTS) -C src $@`
Documentation dir reordered. 2010-02-14 19:11:01 +03:00
Added makefile target to upload docs 2013-03-20 16:45:37 +04:00			`upload:`
			`# this command requires ssh configured to the proper target`
			`tar czf - -C html . \| ssh psycoweb tar xzvf - -C docs/current`

Documentation dir reordered. 2010-02-14 19:11:01 +03:00			`clean:`
Docs build process and docs cleaned up 2015-04-28 11:30:59 +03:00			`$(MAKE) $(SPHOPTS) -C src $@`
Dropped text docs generation 2019-02-17 03:48:33 +03:00			`rm -rf html src/sqlstate_errors.rst`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00
			`env: requirements.txt`
Allow building docs with Python 3 Use a .pth file to simplify finding the just-built psycopg package into the docs building env. 2019-02-17 04:12:39 +03:00			`virtualenv -p $(PYTHON) env`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`./env/bin/pip install -r requirements.txt`
Allow building docs with Python 3 Use a .pth file to simplify finding the just-built psycopg package into the docs building env. 2019-02-17 04:12:39 +03:00			`echo "$$(pwd)/../build/lib.$(PYTHON_VERSION)" \`
			`> env/lib/python$(PYTHON_VERSION)/site-packages/psycopg.pth`