mirror of
https://github.com/psycopg/psycopg2.git
synced 2025-02-19 18:30:33 +03:00
Documentation generated in 'doc/html/' instead of 'doc/_build/html/'
This commit is contained in:
parent
1a3e231e51
commit
12bd7bf7cc
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -7,3 +7,4 @@ MANIFEST
|
||||||
dist/*
|
dist/*
|
||||||
build/*
|
build/*
|
||||||
doc/_build/*
|
doc/_build/*
|
||||||
|
doc/html/*
|
||||||
|
|
|
@ -31,11 +31,12 @@ help:
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
-rm -rf $(BUILDDIR)/*
|
-rm -rf $(BUILDDIR)/*
|
||||||
|
-rm -rf ./html/*
|
||||||
|
|
||||||
html:
|
html:
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ./html
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
@echo "Build finished. The HTML pages are in ./html."
|
||||||
|
|
||||||
dirhtml:
|
dirhtml:
|
||||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
|
|
@ -37,13 +37,12 @@ How to build psycopg documentation
|
||||||
creating ~/pd/lib/python2.6/site-packages/psycopg2
|
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$ cd doc/
|
||||||
(pd)~/pd/psycopg2/doc$ export PYTHONPATH=$(pwd):$PYTHONPATH
|
|
||||||
(pd)~/pd/psycopg2/doc$ make html
|
(pd)~/pd/psycopg2/doc$ make html
|
||||||
Running Sphinx v0.6.4
|
Running Sphinx v0.6.4
|
||||||
...
|
...
|
||||||
|
|
||||||
You should have the in ``_build/html`` now.
|
You should have the rendered documentation in ``./html`` now.
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ import sys, os
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# 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
|
# 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.
|
# 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 -----------------------------------------------------
|
# -- General configuration -----------------------------------------------------
|
||||||
|
|
||||||
|
@ -72,7 +72,7 @@ except ImportError:
|
||||||
|
|
||||||
# List of directories, relative to source directory, that shouldn't be searched
|
# List of directories, relative to source directory, that shouldn't be searched
|
||||||
# for source files.
|
# for source files.
|
||||||
exclude_trees = ['_build']
|
exclude_trees = ['_build', 'html']
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
#default_role = None
|
#default_role = None
|
||||||
|
|
Loading…
Reference in New Issue
Block a user