Build documentation in make html target

To keep the distchecks for the documentation, the documentation has to
be built in the check target instead of distcheck-hook.

While at it, rename doc/.build to doc/_build. This naming is the
default with sphinx 0.6.2.
This commit is contained in:
Petri Lehtinen 2009-11-03 23:07:43 +02:00
parent d1b07171cc
commit bf01067a8a
7 changed files with 23 additions and 15 deletions

View File

@ -1,7 +1,4 @@
EXTRA_DIST = CHANGES LICENSE README.rst
SUBDIRS = doc src test
distcheck-hook:
sphinx-build -b html -W \
$(distdir)/doc \
$(distdir)/_build/doc/.build/html
check-local: html

View File

@ -49,10 +49,9 @@ available at http://www.digip.org/jansson/doc/.
To generate HTML documentation yourself, invoke::
cd doc/
sphinx-build . .build/html
make html
... and point your browser to ``.build/html/index.html``. Sphinx_ is
and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
required to generate the documentation.

2
doc/.gitignore vendored
View File

@ -1 +1 @@
.build/
_build/

View File

@ -2,6 +2,19 @@ EXTRA_DIST = \
conf.py apiref.rst gettingstarted.rst github_commits.c index.rst \
tutorial.rst ext/refcounting.py
SPHINXBUILD = sphinx-build
SPHINXOPTS = -d _build/doctrees -W
html-local:
$(SPHINXBUILD) -b html $(SPHINXOPTS) $(srcdir) _build/html
install-html-local: html
mkdir -p $(DESTDIR)$(htmldir)
cp -r _build/html $(DESTDIR)$(htmldir)
uninstall-local:
rm -rf $(DESTDIR)$(htmldir)
clean-local:
rm -rf .build
rm -rf _build
rm -f ext/refcounting.pyc

View File

@ -1,5 +1,5 @@
To build the documentation, invoke
sphinx-build . .build/html
make html
in this directory. Then point your browser to .build/html/index.html.
Then point your browser to _build/html/index.html.

View File

@ -69,7 +69,7 @@ release = '1.1.1+'
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['.build']
exclude_trees = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

View File

@ -76,10 +76,9 @@ Documentation is in the ``doc/`` subdirectory. It's written in
reStructuredText_ with Sphinx_ annotations. To generate the HTML
documentation, invoke::
cd doc/
sphinx-build . .build/html
make html
... and point your browser to ``.build/html/index.html``. Sphinx_ is
and point your browser to ``doc/_build/html/index.html``. Sphinx_ is
required to generate the documentation.
.. _reStructuredText: http://docutils.sourceforge.net/rst.html