diff options
| author | mattip <matti.picus@gmail.com> | 2018-10-23 11:00:36 +0300 |
|---|---|---|
| committer | mattip <matti.picus@gmail.com> | 2018-10-23 11:00:36 +0300 |
| commit | fc60b27257924ed7f3c140bed00c13a35b057dc8 (patch) | |
| tree | 2307f8b03031305df6eb549790ea9627ab359af4 | |
| parent | 73151451437fa6ce0d8b5f033c1e005885f63cf8 (diff) | |
| download | numpy-fc60b27257924ed7f3c140bed00c13a35b057dc8.tar.gz | |
DOC: add missing docs
| -rw-r--r-- | doc/source/dev/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/alignment.rst (renamed from doc/source/dev/alignment.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/distutils.rst | 3 | ||||
| -rw-r--r-- | doc/source/reference/distutils_guide.rst | 7 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 4 | ||||
| -rw-r--r-- | doc/source/reference/internals.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/style_guide.rst | 8 |
7 files changed, 21 insertions, 3 deletions
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index 9ce04cc1b..1390acb9d 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -6,6 +6,7 @@ Contributing to NumPy :maxdepth: 3 conduct/code_of_conduct + conduct/report_handling_manual gitwash/index development_environment releasing diff --git a/doc/source/dev/alignment.rst b/doc/source/reference/alignment.rst index f067f0d03..f067f0d03 100644 --- a/doc/source/dev/alignment.rst +++ b/doc/source/reference/alignment.rst diff --git a/doc/source/reference/distutils.rst b/doc/source/reference/distutils.rst index 289822909..88e533832 100644 --- a/doc/source/reference/distutils.rst +++ b/doc/source/reference/distutils.rst @@ -13,8 +13,7 @@ distutils, use the :func:`setup <core.setup>` command from :mod:`numpy.distutils.misc_util` that can make it easier to construct keyword arguments to pass to the setup function (by passing the dictionary obtained from the todict() method of the class). More -information is available in the NumPy Distutils Users Guide in -``<site-packages>/numpy/doc/DISTUTILS.txt``. +information is available in the :ref:`distutils-user-guide`. .. index:: diff --git a/doc/source/reference/distutils_guide.rst b/doc/source/reference/distutils_guide.rst new file mode 100644 index 000000000..081719d16 --- /dev/null +++ b/doc/source/reference/distutils_guide.rst @@ -0,0 +1,7 @@ +.. _distutils-user-guide: + +NumPy Distutils - Users Guide +============================= + +.. include:: ../../DISTUTILS.rst.txt + :start-line: 6 diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 2140c57f7..7ba50b882 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -23,8 +23,10 @@ For learning how to use NumPy, see also :ref:`user`. ufuncs routines distutils + distutils_guide c-api internals + style_guide swig @@ -35,4 +37,4 @@ Large parts of this manual originate from Travis E. Oliphant's book `Guide to NumPy <https://archive.org/details/NumPyBook>`__ (which generously entered Public Domain in August 2008). The reference documentation for many of the functions are written by numerous contributors and developers of -NumPy.
\ No newline at end of file +NumPy. diff --git a/doc/source/reference/internals.rst b/doc/source/reference/internals.rst index e1d6644a6..03d081bf9 100644 --- a/doc/source/reference/internals.rst +++ b/doc/source/reference/internals.rst @@ -5,5 +5,6 @@ NumPy internals .. toctree:: internals.code-explanations + alignment .. automodule:: numpy.doc.internals diff --git a/doc/source/reference/style_guide.rst b/doc/source/reference/style_guide.rst new file mode 100644 index 000000000..bede3424d --- /dev/null +++ b/doc/source/reference/style_guide.rst @@ -0,0 +1,8 @@ +.. _style_guide: + +=================== +NumPy C Style Guide +=================== + +.. include:: ../../C_STYLE_GUIDE.rst.txt + :start-line: 4 |