diff --git a/.gitignore b/.gitignore index f9b7c0ed..1f125e0f 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ MANIFEST dist/* build/* doc/_build/* +doc/html/* diff --git a/doc/Makefile b/doc/Makefile index 59ffd355..506f2194 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -31,11 +31,12 @@ help: clean: -rm -rf $(BUILDDIR)/* + -rm -rf ./html/* html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ./html @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + @echo "Build finished. The HTML pages are in ./html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml diff --git a/doc/README b/doc/README index f9f5a028..3936011e 100644 --- a/doc/README +++ b/doc/README @@ -37,13 +37,12 @@ How to build psycopg documentation creating ~/pd/lib/python2.6/site-packages/psycopg2 ... -- Have the ``doc`` dir in the PYTHONPATH and run ``make`` from there:: +- Move to the ``doc`` dir and run ``make`` from there:: (pd)~/pd/psycopg2$ cd doc/ - (pd)~/pd/psycopg2/doc$ export PYTHONPATH=$(pwd):$PYTHONPATH (pd)~/pd/psycopg2/doc$ make html Running Sphinx v0.6.4 ... -You should have the in ``_build/html`` now. +You should have the rendered documentation in ``./html`` now. diff --git a/doc/conf.py b/doc/conf.py index 6dd9ec4a..5622b34f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,7 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) +sys.path.append(os.path.abspath('.')) # -- General configuration ----------------------------------------------------- @@ -72,7 +72,7 @@ except ImportError: # List of directories, relative to source directory, that shouldn't be searched # for source files. -exclude_trees = ['_build'] +exclude_trees = ['_build', 'html'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None