psycopg2/doc/Makefile

.PHONY: env help clean html text doctest

docs: html text

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])')

SPHOPTS=PYTHONPATH=$$(pwd)/../build/lib.$(PYTHON_VERSION)/ SPHINXBUILD=$$(pwd)/env/bin/sphinx-build

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

text:
	$(MAKE) PYTHON=$(PYTHON) -C .. package
	$(MAKE) $(SPHOPTS) -C src $@
	cd src && tools/stitch_text.py index.rst _build/text > ../psycopg2.txt

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
	# this command requires a .pypirc with the right privileges
	python src/tools/pypi_docs_upload.py psycopg2 $$(pwd)/html

clean:
	$(MAKE) $(SPHOPTS) -C src $@
	rm -rf html psycopg2.txt

env: requirements.txt
	virtualenv env
	./env/bin/pip install -r requirements.txt
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`.PHONY: env help clean html text doctest`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
Documentation dir reordered. 2010-02-14 19:11:01 +03:00			`docs: html text`
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])')`

			`SPHOPTS=PYTHONPATH=$$(pwd)/../build/lib.$(PYTHON_VERSION)/ SPHINXBUILD=$$(pwd)/env/bin/sphinx-build`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
			`html:`
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
Generate text documentation in a single file. 2010-02-14 17:45:15 +03:00			`text:`
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			`cd src && tools/stitch_text.py index.rst _build/text > ../psycopg2.txt`
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`
			`# this command requires a .pypirc with the right privileges`
			`python src/tools/pypi_docs_upload.py psycopg2 $$(pwd)/html`

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 $@`
Documentation dir reordered. 2010-02-14 19:11:01 +03:00			`rm -rf html psycopg2.txt`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00
			`env: requirements.txt`
			`virtualenv env`
			`./env/bin/pip install -r requirements.txt`