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'

help:
	$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@

html:
	$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@
	cp -r src/_build/html .

text:
	$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@
	cd src && tools/stitch_text.py index.rst _build/text > ../psycopg2.txt

doctest:
	$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@

clean:
	$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -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'`

First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00			`help:`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@`
First iteration with the Sphinx module documentation. 2010-02-09 07:58:28 +03:00
			`html:`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -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:`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -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:`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -C src $@`
Documentation dir reordered. 2010-02-14 19:11:01 +03:00
			`clean:`
Use virtualenv as build environment for the docs 2014-08-25 02:08:01 +04:00			`$(MAKE) SPHINXBUILD=$$(pwd)/env/bin/sphinx-build -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`