summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2008-12-13 21:02:05 +0000
committerPauli Virtanen <pav@iki.fi>2008-12-13 21:02:05 +0000
commit34eee7e6e21f0983dafa045a55dd208fc973a430 (patch)
tree1a3cfa058ff23c57697eead5c22cd3e86e516ef7 /doc/source
parentf947ff3bf90038bc0b37bc9b6a95138a0cf5e47a (diff)
downloadnumpy-34eee7e6e21f0983dafa045a55dd208fc973a430.tar.gz
docs: fix minor issues, support htmlhelp.
- Don't use :members: in automodule; it generates too much and not very useful output - Fix edit links and summarize.py - Add better htmlhelp build target - Add upload target - Fix permissions on make dist
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/conf.py6
-rw-r--r--doc/source/reference/routines.emath.rst2
-rw-r--r--doc/source/reference/routines.matlib.rst2
-rw-r--r--doc/source/reference/routines.numarray.rst2
-rw-r--r--doc/source/reference/routines.oldnumeric.rst2
5 files changed, 7 insertions, 7 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 249b71fe1..8203812d4 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -21,7 +21,7 @@ if sphinx.__version__ < "0.5":
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'numpydoc',
'phantom_import', 'autosummary', 'sphinx.ext.intersphinx',
- 'sphinx.ext.coverage']
+ 'sphinx.ext.coverage', 'only_directives']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -131,7 +131,7 @@ html_use_modindex = True
#html_file_suffix = '.html'
# Output file base name for HTML help builder.
-htmlhelp_basename = 'NumPydoc'
+htmlhelp_basename = 'numpy'
# Pngmath should try to align formulas properly
pngmath_use_preview = True
@@ -208,7 +208,7 @@ intersphinx_mapping = {'http://docs.python.org/dev': None}
phantom_import_file = 'dump.xml'
# Edit links
-#numpydoc_edit_link = '`Edit </pydocweb/doc/%(full_name)s/>`__'
+numpydoc_edit_link = '`Edit </numpy/docs/%(full_name)s/>`__'
# -----------------------------------------------------------------------------
# Coverage checker
diff --git a/doc/source/reference/routines.emath.rst b/doc/source/reference/routines.emath.rst
index 93c1c6801..9f6c2aaa7 100644
--- a/doc/source/reference/routines.emath.rst
+++ b/doc/source/reference/routines.emath.rst
@@ -7,4 +7,4 @@ Mathematical functions with automatic domain (:mod:`numpy.emath`)
available after :mod:`numpy` is imported.
.. automodule:: numpy.lib.scimath
- :members:
+
diff --git a/doc/source/reference/routines.matlib.rst b/doc/source/reference/routines.matlib.rst
index 25e381f26..7f8a9eabb 100644
--- a/doc/source/reference/routines.matlib.rst
+++ b/doc/source/reference/routines.matlib.rst
@@ -8,4 +8,4 @@ the following replacement functions that return :class:`matrices
<matrix>` instead of :class:`ndarrays <ndarray>`.
.. automodule:: numpy.matlib
- :members:
+
diff --git a/doc/source/reference/routines.numarray.rst b/doc/source/reference/routines.numarray.rst
index 8d47cc989..36e5aa764 100644
--- a/doc/source/reference/routines.numarray.rst
+++ b/doc/source/reference/routines.numarray.rst
@@ -3,4 +3,4 @@ Numarray compatibility (:mod:`numpy.numarray`)
**********************************************
.. automodule:: numpy.numarray
- :members:
+
diff --git a/doc/source/reference/routines.oldnumeric.rst b/doc/source/reference/routines.oldnumeric.rst
index 9c02b4070..d7f15bcfd 100644
--- a/doc/source/reference/routines.oldnumeric.rst
+++ b/doc/source/reference/routines.oldnumeric.rst
@@ -5,4 +5,4 @@ Old Numeric compatibility (:mod:`numpy.oldnumeric`)
.. currentmodule:: numpy
.. automodule:: numpy.oldnumeric
- :members:
+