summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2020-06-06 21:59:48 +0200
committerGitHub <noreply@github.com>2020-06-06 21:59:48 +0200
commit4abd2a845d0723732f26dd9bbba34d076cb7321d (patch)
tree7a19976eb079ac473b57f718c9813ed91ed53759 /doc
parent9439b56f8762b8c9b48d2f9e54dfb467aaa2b3f9 (diff)
parent2198073ae2b8b529851b5a92ad3d0529a8325829 (diff)
downloadnumpy-4abd2a845d0723732f26dd9bbba34d076cb7321d.tar.gz
Merge pull request #16500 from bjnath/move_c_style_link
DOC: Point Contributing page to new NEP 45
Diffstat (limited to 'doc')
-rw-r--r--doc/HOWTO_RELEASE.rst.txt16
-rw-r--r--doc/neps/nep-0029-deprecation_policy.rst2
-rw-r--r--doc/neps/nep-0045-c_style_guide.rst4
-rw-r--r--doc/source/conf.py3
-rw-r--r--doc/source/dev/howto-docs.rst4
-rw-r--r--doc/source/dev/index.rst5
6 files changed, 18 insertions, 16 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt
index 3ee6a8b70..bd15f7f50 100644
--- a/doc/HOWTO_RELEASE.rst.txt
+++ b/doc/HOWTO_RELEASE.rst.txt
@@ -33,16 +33,17 @@ Release Scripts
Supported platforms and versions
================================
-`NEP 29`_ outlines which Python versions are supported; For the first half of
-2020, this will be Python >= 3.6. We test NumPy against all these versions
-every time we merge code to master. Binary installers may be available for a
-subset of these versions (see below).
+:ref:`NEP 29 <NEP29>` outlines which Python versions
+are supported; For the first half of 2020, this will be Python >= 3.6. We test
+NumPy against all these versions every time we merge code to master. Binary
+installers may be available for a subset of these versions (see below).
OS X
----
-OS X versions >= 10.9 are supported, for Python version support see `NEP 29`_.
-We build binary wheels for OSX that are compatible with Python.org Python,
-system Python, homebrew and macports - see this `OSX wheel building summary
+OS X versions >= 10.9 are supported, for Python version support see
+:ref:`NEP 29 <NEP29>`. We build binary wheels for
+OSX that are compatible with Python.org Python, system Python, homebrew and
+macports - see this `OSX wheel building summary
<https://github.com/MacPython/wiki/wiki/Spinning-wheels>`_ for details.
@@ -88,7 +89,6 @@ You will need Cython for building the binaries. Cython compiles the ``.pyx``
files in the NumPy distribution to ``.c`` files.
.. _mingw-w64 toolchain : https://mingwpy.github.io
-.. _NEP 29 : https://numpy.org/neps/nep-0029-deprecation_policy.html
OpenBLAS
------------
diff --git a/doc/neps/nep-0029-deprecation_policy.rst b/doc/neps/nep-0029-deprecation_policy.rst
index 9b6022a81..dbead1b9b 100644
--- a/doc/neps/nep-0029-deprecation_policy.rst
+++ b/doc/neps/nep-0029-deprecation_policy.rst
@@ -1,4 +1,4 @@
-.. _NEP0029:
+.. _NEP29:
==================================================================================
NEP 29 — Recommend Python and Numpy version support as a community policy standard
diff --git a/doc/neps/nep-0045-c_style_guide.rst b/doc/neps/nep-0045-c_style_guide.rst
index 3c21e404f..d7fa6fd97 100644
--- a/doc/neps/nep-0045-c_style_guide.rst
+++ b/doc/neps/nep-0045-c_style_guide.rst
@@ -1,3 +1,5 @@
+.. _NEP45:
+
=================================
NEP 45 — C Style Guide
=================================
@@ -244,7 +246,7 @@ C functions, see the files in ``doc/cdoc/``.
Related Work
------------
-Based on Van Rossum and Warsaw, `PEP 7 -- Style Guide for C Code <https://www.python.org/dev/peps/pep-0007>`_
+Based on Van Rossum and Warsaw, :pep:`7`
Discussion
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d6a0f8bf3..65dcae245 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -240,11 +240,12 @@ texinfo_documents = [
# Intersphinx configuration
# -----------------------------------------------------------------------------
intersphinx_mapping = {
+ 'neps': ('https://numpy.org/neps', None),
'python': ('https://docs.python.org/dev', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'matplotlib': ('https://matplotlib.org', None),
'imageio': ('https://imageio.readthedocs.io/en/stable', None),
- 'skimage': ('https://scikit-image.org/docs/stable', None)
+ 'skimage': ('https://scikit-image.org/docs/stable', None),
}
diff --git a/doc/source/dev/howto-docs.rst b/doc/source/dev/howto-docs.rst
index 281f87cfb..e8bafd254 100644
--- a/doc/source/dev/howto-docs.rst
+++ b/doc/source/dev/howto-docs.rst
@@ -35,8 +35,8 @@ Current vision for the documentation: NEP 44
--------------------------------------------
Recently, the NumPy community approved a *NumPy Enhancement Proposal (NEP)*
-about documentation, `NEP 44 - Restructuring the NumPy Documentation
-<https://www.numpy.org/neps/nep-0044-restructuring-numpy-docs>`__.
+about documentation,
+:ref:`NEP 44 - Restructuring the NumPy Documentation <NEP44>`.
**Where is the documentation?**
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
index fd735f453..aeb277a87 100644
--- a/doc/source/dev/index.rst
+++ b/doc/source/dev/index.rst
@@ -140,8 +140,7 @@ Here's the short summary, complete TOC links are below:
If your change introduces a deprecation, make sure to discuss this first on
GitHub or the mailing list first. If agreement on the deprecation is
- reached, follow `NEP 23 deprecation policy <http://www.numpy.org/neps/
- nep-0023-backwards-compatibility.html>`_ to add the deprecation.
+ reached, follow :ref:`NEP 23 deprecation policy <NEP23>` to add the deprecation.
6. Cross referencing issues
@@ -189,7 +188,7 @@ Stylistic Guidelines
import numpy as np
-* For C code, see the :ref:`numpy-c-style-guide<style_guide>`
+* For C code, see :ref:`NEP 45 <NEP45>`.
Test coverage