diff options
| -rw-r--r-- | doc/source/bugs.rst | 19 | ||||
| -rw-r--r-- | doc/source/dev/depending_on_numpy.rst (renamed from doc/source/user/depending_on_numpy.rst) | 0 | ||||
| -rw-r--r-- | doc/source/dev/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/dev/underthehood.rst | 6 | ||||
| -rw-r--r-- | doc/source/user/basics.rst | 6 | ||||
| -rw-r--r-- | doc/source/user/byteswapping.rst (renamed from doc/source/user/basics.byteswapping.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 27 | ||||
| -rw-r--r-- | doc/source/user/misc.rst | 2 |
8 files changed, 29 insertions, 32 deletions
diff --git a/doc/source/bugs.rst b/doc/source/bugs.rst deleted file mode 100644 index 304a4136a..000000000 --- a/doc/source/bugs.rst +++ /dev/null @@ -1,19 +0,0 @@ -************** -Reporting bugs -************** - -File bug reports or feature requests, and make contributions -(e.g. code patches), by opening a "new issue" on GitHub: - -- NumPy Issues: https://github.com/numpy/numpy/issues - -Please give as much information as you can in the ticket. It is extremely -useful if you can supply a small self-contained code snippet that reproduces -the problem. Also specify the component, the version you are referring to and -the milestone. - -Report bugs to the appropriate GitHub project (there is one for NumPy -and a different one for SciPy). - -More information can be found on the -https://www.scipy.org/scipylib/dev-zone.html website. diff --git a/doc/source/user/depending_on_numpy.rst b/doc/source/dev/depending_on_numpy.rst index ed1397011..ed1397011 100644 --- a/doc/source/user/depending_on_numpy.rst +++ b/doc/source/dev/depending_on_numpy.rst diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index 46ff3a5b2..93b57f7e2 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -265,6 +265,7 @@ The rest of the story reviewer_guidelines ../benchmarking NumPy C style guide <https://numpy.org/neps/nep-0045-c_style_guide.html> + depending_on_numpy releasing governance/index howto-docs diff --git a/doc/source/dev/underthehood.rst b/doc/source/dev/underthehood.rst index c0f37fd5b..53af4a3f1 100644 --- a/doc/source/dev/underthehood.rst +++ b/doc/source/dev/underthehood.rst @@ -1,7 +1,7 @@ .. _underthehood: =========================================== -Under-the-hood Documentation for developers +Under-the-hood documentation for developers =========================================== These documents are intended as a low-level look into NumPy; focused @@ -13,3 +13,7 @@ towards developers. internals internals.code-explanations alignment + ../user/byteswapping + ../user/basics.dispatch + ../user/basics.subclassing + diff --git a/doc/source/user/basics.rst b/doc/source/user/basics.rst index c004d8978..04c20da37 100644 --- a/doc/source/user/basics.rst +++ b/doc/source/user/basics.rst @@ -14,10 +14,6 @@ fundamental NumPy ideas and philosophy. basics.io basics.types basics.broadcasting - basics.byteswapping + basics.copies basics.rec - basics.dispatch - basics.subclassing basics.ufuncs - basics.copies - basics.interoperability diff --git a/doc/source/user/basics.byteswapping.rst b/doc/source/user/byteswapping.rst index ddc375683..ddc375683 100644 --- a/doc/source/user/basics.byteswapping.rst +++ b/doc/source/user/byteswapping.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 3ce6bd804..163aee93e 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -8,21 +8,36 @@ This guide is an overview and explains the important features; details are found in :ref:`reference`. .. toctree:: + :caption: Getting started :maxdepth: 1 whatisnumpy Installation <https://numpy.org/install/> quickstart absolute_beginners + +.. toctree:: + :caption: Fundamentals and usage + :maxdepth: 2 + basics - misc + +.. toctree:: + :maxdepth: 1 + numpy-for-matlab-users - building - c-info NumPy Tutorials <https://numpy.org/numpy-tutorials/features.html> howtos_index - depending_on_numpy +.. toctree:: + :caption: Advanced usage and interoperability + :maxdepth: 1 + + building + c-info + ../f2py/index + ../dev/underthehood + basics.interoperability .. Links to these files are placed directly in the top-level html (doc/source/_templates/indexcontent.html, which appears for the URLs @@ -32,10 +47,8 @@ details are found in :ref:`reference`. .. toctree:: :hidden: + :caption: Extras - ../f2py/index ../glossary - ../dev/underthehood - ../bugs ../release ../license diff --git a/doc/source/user/misc.rst b/doc/source/user/misc.rst index 9b6aa65e2..f0408f181 100644 --- a/doc/source/user/misc.rst +++ b/doc/source/user/misc.rst @@ -1,3 +1,5 @@ +:orphan: + ************* Miscellaneous ************* |