diff options
23 files changed, 260 insertions, 23 deletions
diff --git a/doc/neps/Makefile b/doc/neps/Makefile new file mode 100644 index 000000000..2d1a063de --- /dev/null +++ b/doc/neps/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = NumPyEnhancementProposals +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/neps/conf.py b/doc/neps/conf.py new file mode 100644 index 000000000..aa11d37b3 --- /dev/null +++ b/doc/neps/conf.py @@ -0,0 +1,221 @@ +# -*- coding: utf-8 -*- +# +# NumPy Enhancement Proposals documentation build configuration file, created by +# sphinx-quickstart on Mon Dec 11 12:45:09 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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. +# +import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.imgmath', + 'sphinx.ext.graphviz'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['../source/_templates/'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'NumPy Enhancement Proposals' +copyright = u'2017, NumPy Developers' +author = u'NumPy Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'' +# The full version, including alpha/beta/rc tags. +release = u'' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +## -- Options for HTML output ---------------------------------------------- +# +## The theme to use for HTML and HTML Help pages. See the documentation for +## a list of builtin themes. +## +#html_theme = 'alabaster' +# +## Theme options are theme-specific and customize the look and feel of a theme +## further. For a list of options available for each theme, see the +## documentation. +## +## html_theme_options = {} +# +## Add any paths that contain custom static files (such as style sheets) here, +## relative to this directory. They are copied after the builtin static files, +## so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] +# +## Custom sidebar templates, must be a dictionary that maps document names +## to template names. +## +## This is required for the alabaster theme +## refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +#html_sidebars = { +# '**': [ +# 'relations.html', # needs 'show_related': True theme option to display +# 'searchbox.html', +# ] +#} + +## ----------------------------------------------------------------------------- +# HTML output +# ----------------------------------------------------------------------------- + +themedir = os.path.join(os.pardir, 'scipy-sphinx-theme', '_theme') +if not os.path.isdir(themedir): + raise RuntimeError("Get the scipy-sphinx-theme first, " + "via git submodule init && git submodule update") + +html_theme = 'scipy' +html_theme_path = [themedir] + +#if 'scipyorg' in tags: +if True: + # Build for the scipy.org website + html_theme_options = { + "edit_link": True, + "sidebar": "right", + "scipy_org_logo": True, + "rootlinks": [("http://scipy.org/", "Scipy.org"), + ("http://docs.scipy.org/", "Docs")] + } +else: + # Default build + html_theme_options = { + "edit_link": False, + "sidebar": "left", + "scipy_org_logo": False, + "rootlinks": [] + } + html_sidebars = {'index': 'indexsidebar.html'} + +#html_additional_pages = { +# 'index': 'indexcontent.html', +#} + +html_title = "%s" % (project) +html_static_path = ['../source/_static'] +html_last_updated_fmt = '%b %d, %Y' + +html_use_modindex = True +html_copy_source = False +html_domain_indices = False +html_file_suffix = '.html' + +htmlhelp_basename = 'numpy' + +if 'sphinx.ext.pngmath' in extensions: + pngmath_use_preview = True + pngmath_dvipng_args = ['-gamma', '1.5', '-D', '96', '-bg', 'Transparent'] + +plot_html_show_formats = False +plot_html_show_source_link = False + + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NumPyEnhancementProposalsdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NumPyEnhancementProposals.tex', u'NumPy Enhancement Proposals Documentation', + u'NumPy Developers', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'numpyenhancementproposals', u'NumPy Enhancement Proposals Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NumPyEnhancementProposals', u'NumPy Enhancement Proposals Documentation', + author, 'NumPyEnhancementProposals', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/doc/source/neps/index.rst b/doc/neps/index.rst index d85f33606..e26190b1f 100644 --- a/doc/source/neps/index.rst +++ b/doc/neps/index.rst @@ -9,6 +9,16 @@ written up when large changes to NumPy are proposed. This page provides an overview of all NEPs, making only a distinction between the ones that have been implemented and those that have not been implemented. +Meta-NEPs (NEPs about NEPs or Processes) +---------------------------------------- + +.. toctree:: + :maxdepth: 1 + + nep-0000 + nep-template + + Implemented NEPs ---------------- @@ -20,6 +30,7 @@ Implemented NEPs new-iterator-ufunc npy-format + Other NEPs ---------- diff --git a/doc/neps/nep-0000.rst b/doc/neps/nep-0000.rst index 9e3b863bc..bfcfac23b 100644 --- a/doc/neps/nep-0000.rst +++ b/doc/neps/nep-0000.rst @@ -188,7 +188,7 @@ References and Footnotes `GitHub <https://github.com/numpy/numpy/tree/master/doc/neps>`_. .. [2] The URL for viewing NEPs on the web is - https://docs.scipy.org/doc/numpy-1.13.0/neps/index.html. + http://numpy.github.io/neps/. .. _repo: https://github.com/numpy/numpy diff --git a/doc/release/1.3.0-notes.rst b/doc/release/1.3.0-notes.rst index 246ec5869..3ec93e0b0 100644 --- a/doc/release/1.3.0-notes.rst +++ b/doc/release/1.3.0-notes.rst @@ -235,7 +235,7 @@ This should make the porting to new platforms easier, and more robust. In particular, the configuration stage does not need to execute any code on the target platform, which is a first step toward cross-compilation. -http://projects.scipy.org/numpy/browser/trunk/doc/neps/math_config_clean.txt +http://numpy.github.io/neps/math_config_clean.html umath refactor -------------- @@ -247,7 +247,7 @@ Improvements to build warnings Numpy can now build with -W -Wall without warnings -http://projects.scipy.org/numpy/browser/trunk/doc/neps/warnfix.txt +http://numpy.github.io/neps/warnfix.html Separate core math library -------------------------- diff --git a/doc/source/_templates/indexcontent.html b/doc/source/_templates/indexcontent.html index 3fbb616c6..2db4da5e0 100644 --- a/doc/source/_templates/indexcontent.html +++ b/doc/source/_templates/indexcontent.html @@ -34,7 +34,7 @@ <td width="50%"> <p class="biglink"><a class="biglink" href="{{ pathto("bugs") }}">Reporting bugs</a></p> <p class="biglink"><a class="biglink" href="{{ pathto("about") }}">About NumPy</a></p> - <p class="biglink"><a class="biglink" href="{{ pathto("neps/index") }}">NumPy Enhancement Proposals</a><br/> + <p class="biglink"><a class="biglink" href="{{ pathto("http://numpy.github.io/neps") }}">NumPy Enhancement Proposals</a><br/> </td><td width="50%"> <p class="biglink"><a class="biglink" href="{{ pathto("release") }}">Release Notes</a></p> <p class="biglink"><a class="biglink" href="{{ pathto("license") }}">License of NumPy</a></p> diff --git a/doc/source/contents.rst b/doc/source/contents.rst index 61c0037fc..fad9be76e 100644 --- a/doc/source/contents.rst +++ b/doc/source/contents.rst @@ -8,7 +8,6 @@ NumPy manual contents reference/index f2py/index dev/index - neps/index release about bugs diff --git a/doc/source/neps/datetime-proposal.rst b/doc/source/neps/datetime-proposal.rst deleted file mode 100644 index 05f0182b7..000000000 --- a/doc/source/neps/datetime-proposal.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/datetime-proposal.rst diff --git a/doc/source/neps/datetime-proposal3.rst b/doc/source/neps/datetime-proposal3.rst deleted file mode 100644 index fa9102a96..000000000 --- a/doc/source/neps/datetime-proposal3.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/datetime-proposal3.rst diff --git a/doc/source/neps/deferred-ufunc-evaluation.rst b/doc/source/neps/deferred-ufunc-evaluation.rst deleted file mode 100644 index b4a7a457d..000000000 --- a/doc/source/neps/deferred-ufunc-evaluation.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/deferred-ufunc-evaluation.rst diff --git a/doc/source/neps/dropping-python2.7-proposal.rst b/doc/source/neps/dropping-python2.7-proposal.rst deleted file mode 100644 index c67a626be..000000000 --- a/doc/source/neps/dropping-python2.7-proposal.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/dropping-python2.7-proposal.rst diff --git a/doc/source/neps/generalized-ufuncs.rst b/doc/source/neps/generalized-ufuncs.rst deleted file mode 100644 index 8b28f0224..000000000 --- a/doc/source/neps/generalized-ufuncs.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/generalized-ufuncs.rst diff --git a/doc/source/neps/groupby_additions.rst b/doc/source/neps/groupby_additions.rst deleted file mode 100644 index 61abc951e..000000000 --- a/doc/source/neps/groupby_additions.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/groupby_additions.rst diff --git a/doc/source/neps/math_config_clean.rst b/doc/source/neps/math_config_clean.rst deleted file mode 100644 index 25b340e51..000000000 --- a/doc/source/neps/math_config_clean.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/math_config_clean.rst diff --git a/doc/source/neps/missing-data.rst b/doc/source/neps/missing-data.rst deleted file mode 100644 index f9899f1b0..000000000 --- a/doc/source/neps/missing-data.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/missing-data.rst diff --git a/doc/source/neps/new-iterator-ufunc.rst b/doc/source/neps/new-iterator-ufunc.rst deleted file mode 100644 index 7e06aa8ae..000000000 --- a/doc/source/neps/new-iterator-ufunc.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/new-iterator-ufunc.rst diff --git a/doc/source/neps/newbugtracker.rst b/doc/source/neps/newbugtracker.rst deleted file mode 100644 index 70ea21f8c..000000000 --- a/doc/source/neps/newbugtracker.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/newbugtracker.rst diff --git a/doc/source/neps/npy-format.rst b/doc/source/neps/npy-format.rst deleted file mode 100644 index bd1f2bb5c..000000000 --- a/doc/source/neps/npy-format.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/npy-format.rst diff --git a/doc/source/neps/structured_array_extensions.rst b/doc/source/neps/structured_array_extensions.rst deleted file mode 100644 index 341e6c955..000000000 --- a/doc/source/neps/structured_array_extensions.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/structured_array_extensions.rst diff --git a/doc/source/neps/ufunc-overrides.rst b/doc/source/neps/ufunc-overrides.rst deleted file mode 100644 index 2e293ec44..000000000 --- a/doc/source/neps/ufunc-overrides.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/ufunc-overrides.rst diff --git a/doc/source/neps/warnfix.rst b/doc/source/neps/warnfix.rst deleted file mode 100644 index 1b9b1b87b..000000000 --- a/doc/source/neps/warnfix.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../neps/warnfix.rst diff --git a/doc/source/reference/routines.io.rst b/doc/source/reference/routines.io.rst index 5df590f17..573498792 100644 --- a/doc/source/reference/routines.io.rst +++ b/doc/source/reference/routines.io.rst @@ -14,7 +14,7 @@ NumPy binary files (NPY, NPZ) savez_compressed The format of these binary file types is documented in -http://docs.scipy.org/doc/numpy/neps/npy-format.html +http://numpy.github.io/neps/npy-format.html Text files ---------- diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index 66dc68538..9ee0aaaae 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -477,7 +477,7 @@ def save(file, arr, allow_pickle=True, fix_imports=True): ----- For a description of the ``.npy`` format, see the module docstring of `numpy.lib.format` or the NumPy Enhancement Proposal - http://docs.scipy.org/doc/numpy/neps/npy-format.html + http://numpy.github.io/neps/npy-format.html Examples -------- @@ -563,7 +563,7 @@ def savez(file, *args, **kwds): in the archive contains one variable in ``.npy`` format. For a description of the ``.npy`` format, see `numpy.lib.format` or the NumPy Enhancement Proposal - http://docs.scipy.org/doc/numpy/neps/npy-format.html + http://numpy.github.io/neps/npy-format.html When opening the saved ``.npz`` file with `load` a `NpzFile` object is returned. This is a dictionary-like object which can be queried for @@ -644,7 +644,7 @@ def savez_compressed(file, *args, **kwds): ``zipfile.ZIP_DEFLATED`` and each file in the archive contains one variable in ``.npy`` format. For a description of the ``.npy`` format, see `numpy.lib.format` or the NumPy Enhancement Proposal - http://docs.scipy.org/doc/numpy/neps/npy-format.html + http://numpy.github.io/neps/npy-format.html When opening the saved ``.npz`` file with `load` a `NpzFile` object is returned. This is a dictionary-like object which can be queried for |