diff options
| author | Pauli Virtanen <pav@iki.fi> | 2010-09-28 12:11:38 +0200 |
|---|---|---|
| committer | Pauli Virtanen <pav@iki.fi> | 2010-10-01 12:13:21 +0200 |
| commit | 6716be40b753daff7d705fcd440bd9e67198cff2 (patch) | |
| tree | c22fa123a1b8e6ad2a9a827b840c7f9603b8f2be /doc | |
| parent | 4510c4a81185eed7e144f75ec5121f80bc924a6e (diff) | |
| download | numpy-6716be40b753daff7d705fcd440bd9e67198cff2.tar.gz | |
DOC: explicitly require Sphinx >= 1.0.1
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HOWTO_BUILD_DOCS.txt | 4 | ||||
| -rw-r--r-- | doc/Makefile | 7 | ||||
| -rw-r--r-- | doc/source/conf.py | 19 |
3 files changed, 8 insertions, 22 deletions
diff --git a/doc/HOWTO_BUILD_DOCS.txt b/doc/HOWTO_BUILD_DOCS.txt index 8c1722712..3b677263b 100644 --- a/doc/HOWTO_BUILD_DOCS.txt +++ b/doc/HOWTO_BUILD_DOCS.txt @@ -3,9 +3,7 @@ Building the NumPy API and reference docs ========================================= We currently use Sphinx_ for generating the API and reference -documentation for Numpy. You will need Sphinx 0.5 or newer. Sphinx's -current development version also works as of now (2009-06-24), and -using it is recommended though not required. +documentation for Numpy. You will need Sphinx 1.0.1 or newer. If you only want to get the documentation, note that pre-built versions can be found at diff --git a/doc/Makefile b/doc/Makefile index 5058fbc42..30caa1f3b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -11,8 +11,6 @@ PAPER = FILES= -NEED_AUTOSUMMARY = $(shell $(PYTHON) -c 'import sphinx; print sphinx.__version__ < "0.7" and "1" or ""') - # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter @@ -99,11 +97,6 @@ dist-build: generate: build/generate-stamp build/generate-stamp: $(wildcard source/reference/*.rst) mkdir -p build -ifeq ($(NEED_AUTOSUMMARY),1) - $(PYTHON) \ - ./sphinxext/autosummary_generate.py source/reference/*.rst \ - -p dump.xml -o source/reference/generated -endif touch build/generate-stamp html: generate diff --git a/doc/source/conf.py b/doc/source/conf.py index 59bf3e909..4dfec91db 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -4,8 +4,10 @@ import sys, os, re # Check Sphinx version import sphinx -if sphinx.__version__ < "0.5": - raise RuntimeError("Sphinx 0.5.dev or newer required") +if sphinx.__version__ < "1.0.1": + raise RuntimeError("Sphinx 1.0.1 or newer required") + +needs_sphinx = '1.0' # ----------------------------------------------------------------------------- # General configuration @@ -18,15 +20,9 @@ sys.path.insert(0, os.path.abspath('../sphinxext')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'numpydoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', - 'sphinx.ext.doctest', + 'sphinx.ext.doctest', 'sphinx.ext.autosummary', 'plot_directive'] -if sphinx.__version__ >= "0.7": - extensions.append('sphinx.ext.autosummary') -else: - extensions.append('autosummary') - extensions.append('only_directives') - # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -222,9 +218,8 @@ numpydoc_use_plots = True # Autosummary # ----------------------------------------------------------------------------- -if sphinx.__version__ >= "0.7": - import glob - autosummary_generate = glob.glob("reference/*.rst") +import glob +autosummary_generate = glob.glob("reference/*.rst") # ----------------------------------------------------------------------------- # Coverage checker |