10000 Merge pull request #10213 from jarrodmillman/nep-process · eric-wieser/numpy@728af07 · GitHub
[go: up one dir, main page]
Skip to content

Commit 728af07

Browse files
charrischarris
authored
Merge pull request numpy#10213 from jarrodmillman/nep-process
ENH: Set up proposed NEP process
2 parents 05df34f + 489c13b commit 728af07

26 files changed

+546
-1402
lines changed

‎doc/neps/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = NumPyEnhancementProposals
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/neps/_static/nep-0000.png

20.3 KB
Loading

‎doc/neps/conf.py

Lines changed: 221 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# NumPy Enhancement Proposals documentation build configuration file, created by
4+
# sphinx-quickstart on Mon Dec 11 12:45:09 2017.
5+
#
6+
# This file is execfile()d with the current directory set to its
7+
# containing dir.
8+
#
9+
# Note that not all possible configuration values are present in this
10+
# autogenerated file.
11+
#
12+
# All configuration values have a default; values that are commented out
13+
# serve to show the default.
14+
15+
# If extensions (or modules to document with autodoc) are in another directory,
16+
# add these directories to sys.path here. If the directory is relative to the
17+
# documentation root, use os.path.abspath to make it absolute, like shown here.
18+
#
19+
import os
20+
# import sys
21+
# sys.path.insert(0, os.path.abspath('.'))
22+
23+
24+
# -- General configuration ------------------------------------------------
25+
26+
# If your documentation needs a minimal Sphinx version, state it here.
27+
#
28+
# needs_sphinx = '1.0'
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = ['sphinx.ext.imgmath',
34+
'sphinx.ext.graphviz']
35+
36+
# Add any paths that contain templates here, relative to this directory.
37+
templates_path = ['../source/_templates/']
38+
39+
# The suffix(es) of source filenames.
40+
# You can specify multiple suffix as a list of string:
41+
#
42+
# source_suffix = ['.rst', '.md']
43+
source_suffix = '.rst'
44+
45+
# The master toctree document.
46+
master_doc = 'index'
47+
48+
# General information about the project.
49+
project = u'NumPy Enhancement Proposals'
50+
copyright = u'2017, NumPy Developers'
51+
author = u'NumPy Developers'
52+
53+
# The version info for the project you're documenting, acts as replacement for
54+
# |version| and |release|, also used in various other places throughout the
55+
# built documents.
56+
#
57+
# The short X.Y version.
58+
version = u''
59+
# The full version, including alpha/beta/rc tags.
60+
release = u''
61+
62+
# The language for content autogenerated by Sphinx. Refer to documentation
63+
# for a list of supported languages.
64+
#
65+
# This is also used if you do content translation via gettext catalogs.
66+
# Usually you set "language" from the command line for these cases.
67+
language = None
68+
69+
# List of patterns, relative to source directory, that match files and
70+
# directories to ignore when looking for source files.
71+
# This patterns also effect to html_static_path and html_extra_path
72+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
73+
74+
# The name of the Pygments (syntax highlighting) style to use.
75+
pygments_style = 'sphinx'
76+
77+
# If true, `todo` and `todoList` produce output, else they produce nothing.
78+
todo_include_todos = False
79+
80+
81+
## -- Options for HTML output ----------------------------------------------
82+
#
83+
## The theme to use for HTML and HTML Help pages. See the documentation for
84+
## a list of builtin themes.
85+
##
86+
#html_theme = 'alabaster'
87+
#
88+
## Theme options are theme-specific and customize the look and feel of a theme
89+
## further. For a list of options available for each theme, see the
90+
## documentation.
91+
##
92+
## html_theme_options = {}
93+
#
94+
## Add any paths that contain custom static files (such as style sheets) here,
95+
## relative to this directory. They are copied after the builtin static files,
96+
## so a file named "default.css" will overwrite the builtin "default.css".
97+
#html_static_path = ['_static']
98+
#
99+
## Custom sidebar templates, must be a dictionary that maps document names
100+
## to template names.
101+
##
102+
## This is required for the alabaster theme
103+
## refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
104+
#html_sidebars = {
105+
# '**': [
106+
# 'relations.html', # needs 'show_related': True theme option to display
107+
# 'searchbox.html',
108+
# ]
109+
#}
110+
111+
## -----------------------------------------------------------------------------
112+
# HTML output
113+
# -----------------------------------------------------------------------------
114+
115+
themedir = os.path.join(os.pardir, 'scipy-sphinx-theme', '_theme')
116+
if not os.path.isdir(themedir):
117+
raise RuntimeError("Get the scipy-sphinx-theme first, "
118+
"via git submodule init && git submodule update")
119+
120+
html_theme = 'scipy'
121+
html_theme_path = [themedir]
122+
123+
#if 'scipyorg' in tags:
124+
if True:
125+
# Build for the scipy.org website
126+
html_theme_options = {
127+
"edit_link": True,
128+
"sidebar": "right",
129+
"scipy_org_logo": True,
130+
"rootlinks": [("http://scipy.org/", "Scipy.org"),
131+
("http://docs.scipy.org/", "Docs")]
132+
}
133+
else:
134+
# Default build
135+
html_theme_options = {
136+
"edit_link": False,
137+
"sidebar": "left",
138+
"scipy_org_logo": False,
139+
"rootlinks": []
140+
}
141+
html_sidebars = {'index': 'indexsidebar.html'}
142+
143+
#html_additional_pages = {
144+
# 'index': 'indexcontent.html',
145+
#}
146+
147+
html_title = "%s" % (project)
148+
html_static_path = ['../source/_static']
149+
html_last_updated_fmt = '%b %d, %Y'
150+
151+
html_use_modindex = True
152+
html_copy_source = False
153+
html_domain_indices = False
154+
html_file_suffix = '.html'
155+
156+
htmlhelp_basename = 'numpy'
157+
158+
if 'sphinx.ext.pngmath' in extensions:
159+
pngmath_use_preview = True
160+
pngmath_dvipng_args = ['-gamma', '1.5', '-D', '96', '-bg', 'Transparent']
161+
162+
plot_html_show_formats = False
163+
plot_html_show_source_link = False
164+
165+
166+
167+
# -- Options for HTMLHelp output ------------------------------------------
168+
169+
# Output file base name for HTML help builder.
170+
htmlhelp_basename = 'NumPyEnhancementProposalsdoc'
171+
172+
173+
# -- Options for LaTeX output ---------------------------------------------
174+
175+
latex_elements = {
176+
# The paper size ('letterpaper' or 'a4paper').
177+
#
178+
# 'papersize': 'letterpaper',
179+
180+
# The font size ('10pt', '11pt' or '12pt').
181+
#
182+
# 'pointsize': '10pt',
183+
184+
# Additional stuff for the LaTeX preamble.
185+
#
186+
# 'preamble': '',
187+
188+
# Latex figure (float) alignment
189+
#
190+
# 'figure_align': 'htbp',
191+
}
192+
193+
# Grouping the document tree into LaTeX files. List of tuples
194+
# (source start file, target name, title,
195+
# author, documentclass [howto, manual, or own class]).
196+
latex_documents = [
197+
(master_doc, 'NumPyEnhancementProposals.tex', u'NumPy Enhancement Proposals Documentation',
198+
u'NumPy Developers', 'manual'),
199+
]
200+
201+
202+
# -- Options for manual page output ---------------------------------------
203+
204+
# One entry per manual page. List of tuples
205+
# (source start file, name, description, authors, manual section).
206+
man_pages = [
207+
(master_doc, 'numpyenhancementproposals', u'NumPy Enhancement Proposals Documentation',
208+
[author], 1)
209+
]
210+
211+
212+
# -- Options for Texinfo output -------------------------------------------
213+
214+
# Grouping the document tree into Texinfo files. List of tuples
215+
# (source start file, target name, title, author,
216+
# dir menu entry, description, category)
217+
texinfo_documents = [
218+
(master_doc, 'NumPyEnhancementProposals', u'NumPy Enhancement Proposals Documentation',
219+
author, 'NumPyEnhancementProposals', 'One line description of project.',
220+
'Miscellaneous'),
221+
]

‎doc/source/neps/index.rst renamed to ‎doc/neps/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ written up when large changes to NumPy are proposed.
99
This page provides an overview of all NEPs, making only a distinction between
1010
the ones that have been implemented and those that have not been implemented.
1111

12+
Meta-NEPs (NEPs about NEPs or Processes)
13+
----------------------------------------
14+
15+
.. toctree::
16+
:maxdepth: 1
17+
18+
nep-0000
19+
nep-template
20+
21+
1222
Implemented NEPs
1323
----------------
1424

@@ -20,6 +30,7 @@ Implemented NEPs
2030
new-iterator-ufunc
2131
npy-format
2232

33+
2334
Other NEPs
2435
----------
2536

0 commit comments

Comments
 (0)
0