8000 Merge pull request #12250 from mattip/add-docs-to-toc · numpy/numpy@bc81177 · GitHub
[go: up one dir, main page]
Skip to content

Commit bc81177

Browse files
rgommersrgommers
authored
Merge pull request #12250 from mattip/add-docs-to-toc
DOC: add missing docs
2 parents 619926d + 1490fc8 commit bc81177

File tree

11 files changed

+46
-335
lines changed

11 files changed

+46
-335
lines changed

‎doc/CAPI.rst.txt

Lines changed: 0 additions & 320 deletions
This file was deleted.

‎doc/source/dev/conduct/report_handling_manual.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
.. _CoC_reporting_manual:
24

35
NumPy Code of Conduct - How to follow up on a report

‎doc/source/dev/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Contributing to NumPy
88
conduct/code_of_conduct
99
gitwash/index
1010
development_environment
11+
style_guide
1112
releasing
1213
governance/index
1314

‎doc/source/dev/style_guide.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _style_guide:
2+
3+
===================
4+
NumPy C Style Guide
5+
===================
6+
7+
.. include:: ../../C_STYLE_GUIDE.rst.txt
8+
:start-line: 4

‎doc/source/dev/alignment.rst renamed to ‎doc/source/reference/alignment.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
.. _alignment:
22

3+
Memory Alignment
4+
================
35

46
Numpy Alignment Goals
5-
=====================
7+
---------------------
68

79
There are three use-cases related to memory alignment in numpy (as of 1.14):
810

@@ -33,7 +35,7 @@ alignment of 4 and "uint" alignment of 8 (equal to the true alignment of
3335
``uint64``).
3436

3537
Variables in Numpy which control and describe alignment
36-
=======================================================
38+
-------------------------------------------------------
3739

3840
There are 4 relevant uses of the word ``align`` used in numpy:
3941

@@ -60,7 +62,7 @@ There are 4 relevant uses of the word ``align`` used in numpy:
6062
an analagous way to how ``IsAligned`` checks for true-alignment.
6163

6264
Consequences of alignment
63-
=========================
65+
-------------------------
6466

6567
Here is how the variables above are used:
6668

0 commit comments

Comments
 (0)
0