summaryrefslogtreecommitdiff
path: root/doc/source/reference
Commit message (Collapse)AuthorAgeFilesLines
...
* | DOC: Remove the links for ``True`` and ``False`` (#16887)Takanori H2020-07-312-6/+6
|/ | | * DOC: use :py:data:True and :py:data:False
* Merge pull request #16896 from takanori-pskq/i13114-5Matti Picus2020-07-317-178/+169
|\ | | | | DOC: Improve documentation of C code
| * DOC: Fixuptakanori-pskq2020-07-252-14/+5
| |
| * DOC: Fix the role of references (var -> macro)takanori-pskq2020-07-257-163/+163
| |
| * DOC: Remove links for C codestakanori-pskq2020-07-181-3/+3
| |
* | DOC: Fix the declarations of C fuctions (#16897)Takanori H2020-07-311-2/+2
| | | | | | * DOC: Fix the declarations of C fuctions
* | DOC: Add ufunc docstring to generated docs.Ross Barnowski2020-07-201-0/+5
|/ | | | | | | | Adds the ufunc class to the documentation so that it is included in the generated html docs and all links to it work. Slightly modify ufunc docstring to remove unrecognized heading name.
* DOC: describe ufunc copy behavior when input and output overlap (#16826)Neal C2020-07-161-0/+13
| | | | | | | Describing ufunc copy behaviour when input and output overlaps. Closes #16749 Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Merge pull request #16836 from seiko2plus/doc_simd_improve_ftablesSebastian Berg2020-07-144-198/+282
|\ | | | | DOC: improve SIMD features tables
| * DOC: improve SIMD features tablesSayed Adel2020-07-144-198/+282
| | | | | | | | | | | | - improve the tables generator(style/simplify) - show the differences between the compilers - add an explanation about interrelated CPU features
* | Update doc/source/reference/random/index.rstCharles Harris2020-07-131-2/+1
| | | | | | Co-authored-by: Matti Picus <matti.picus@gmail.com>
* | DOC: use print() instead of str() for generator object to pass circleci testsLaurie2020-07-121-9/+9
| |
* | DOC: updates based on mattip's suggestions, add seed to all default_rng so ↵Laurie2020-07-121-24/+22
| | | | | | | | tests will pass, get rid of directly printing generator object
* | DOC: add examples to random number generator pagesLaurie2020-07-121-20/+59
|/
* DOC: Add SIMD optimization documentation (gh-15551)Matti Picus2020-07-126-0/+774
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add documentation for the new build infrastructure and API developed to enable universal intrinsics. Written by @seiko2plus with some fixes by @mattip. * DOC: add SIMD optimization doc (seiko2plus) * DOC: reformat as valid RST * trim whitespace * first part of Understanding CPU Dispatching * update build options and remove implied features, gonna update it later * add more explanations for the dispatcher and fix doc style * fix up style * add figure * Improve and more explanations for Understanding CPU Dispatching * fix up syntax * DOC: tweak formatting * DOC: more tweaks * fix rst formatting * DOC: Generate CPU features tables from CCompilerOpt * DOC: move files around * DOC: add comment to top of file * DOC: rebuild tables, fix links * DOC: minor copyedits Co-authored-by: Sayed Adel <seiko@imavr.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Update doc/source/reference/arrays.nditer.rst dpitch402020-07-081-1/+3
| | | | | Improve wording Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* DOC: fix rST note directive formatting.Ross Barnowski2020-07-071-1/+3
|
* Added note at the top of the reference section on iteration linking to the ↵David Pitchford2020-07-071-0/+4
| | | | quickstart documentation section on basic iteration
* Merge pull request #16738 from Qiyu8/fix_typoMatti Picus2020-07-031-1/+1
|\ | | | | DOC: Remove redundant word
| * remove redundant wordQiyu82020-07-031-1/+1
| |
* | DOC: reword random c-api introduction, cython is documented in Extending ↵Matti Picus2020-07-021-13/+7
| | | | | | | | | | (#16731) DOC: reword random c-api introduction, cython is documented in Extending
* | DOC: Add lib.format.open_memmap to autosummary.Ross Barnowski2020-06-221-1/+1
|/ | | | | Fixes link in See also section of np.memmap docs and ensures open_memmap is included in the summary of io functions.
* Merge pull request #13516 from seiko2plus/core_improve_infa_buildMatti Picus2020-06-171-0/+1
|\ | | | | ENH: enable multi-platform SIMD compiler optimizations
| * ENH: [1/7] enable multi-platform SIMD compiler optimizationsSayed Adel2020-06-151-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Implement new distutils class `CCompilerOpt`, used for handling the CPU/hardware optimization, starting from parsing the command arguments, to managing the relationship between the CPU baseline and dispatch-able features, also generating the required C headers and ending with compiling the sources with proper compiler's flags. `CCompilerOpt` mainly used as a helper class for `CCompiler`, and doesn't provide any runtime detection for the CPU features, instead only focuses on the compiler side, but it generates abstract C headers that can be used later for the final runtime dispatching process.
* | DOC: add documentation for the numpy.typing moduleJosh Wilson2020-06-102-0/+3
|/
* DOC: Fixes for 18 broken links (#16472)bjnath2020-06-064-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Fixes for 18 broken links This, with PR #16465, should fix nearly all the remaining broken links on the site. 4 or 5 others should be easy to fix and just need attention from someone more knowledgeable -- will open an issue. For release notes with dead links, I could usually find links on archive.org for roughly contemporary versions. * DOC: Update to "Fixes for 18 broken links #16472" * Obsolete links, previously commented out, now deleted: https://github.com/numpy/numpy/pull/16472#discussion_r433928958 * Semantic markup for reference to Python class: https://github.com/numpy/numpy/pull/16472#discussion_r433553928 * Missing :ref: in internal link: https://github.com/numpy/numpy/pull/16472#discussion_r433554484 Not included: Resolution on using external/internal doc link in .py: https://github.com/numpy/numpy/pull/16472#discussion_r433554824 * DOC: Add internal link for 'Fixes for 18 broken links' PR #16472 Making reference [1] an internal link in function_base.py => numpy.vectorize.html * DOC: Redirect 2 link fixes in PR #16472 * governance.rst link reverted * ununcs.rst `overridden` link goes where it was meant to per https://github.com/numpy/numpy/pull/16472#pullrequestreview-424666070
* Merge pull request #15666 from rossbar/enh/poly_strMatti Picus2020-06-042-3/+26
|\ | | | | ENH: Improved `__str__` for polynomials
| * DOC: Update poly class refguide printing.Ross Barnowski2020-05-152-3/+26
| | | | | | | | | | | | | | | | | | Update routines.polynomials.classes doc in the refguide to reflect changes to polynomial printing. Add additional information to the document about the various ways that the string representation of polynomial expressions can be controlled via formatting.
* | DOC: Fix spelling typo - homogenous to homogeneous. (#16324)Kevin Moore2020-05-212-2/+2
| |
* | DOC: Correct documentation of ``__array__`` when used as output array. (#16130)Tina Oberoi2020-05-211-3/+2
| |
* | Merge pull request #16156 from WarrenWeckesser/deprecate-dualSebastian Berg2020-05-191-1/+1
|\ \ | | | | | | DEP: Deprecate `numpy.dual`.
| * | DOC: dual: Note the deprecation of numpy.dual in the dual module docstring.Warren Weckesser2020-05-051-1/+1
| | | | | | | | | | | | Also make the correction "Scipy" -> "SciPy" in a few places.
* | | DOC: Add PyArray_ContiguousFromObject C docs (gh-16207)Guilherme Leobas2020-05-181-3/+11
| | | | | | | | | | | | | | | | | | Add documentation for `PyArray_ContiguousFromObject` similar to the other macros wrapping `PyArray_FromAny` Fixes #16196
* | | DOC: Fix typos and cosmetic issuesMartin Michlmayr2020-05-174-5/+5
| | |
* | | DOC: Unify cross-references between array joining methodsTim Hoffmann2020-05-102-8/+8
| | |
* | | Merge pull request #16078 from rossbar/doc/axis_to_new_or_differentMatti Picus2020-05-072-0/+15
|\ \ \ | |/ / |/| | DOC: Add axis to random module "new or different" docs
| * | DOC: Added `permutation` to methods with axis kwarg.Ross Barnowski2020-04-252-6/+7
| | | | | | | | | | | | | | | Added `permutation` to `choice` and `shuffle` in the list of highlighted methods with an `axis` kwarg.
| * | DOC: Added bullet about axis kwarg to rng overview docs.Ross Barnowski2020-04-252-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | Modified the introductory/overview documentation for the random module to highlight the addition of the `axis` kwarg to methods like `shuffle` and `choice` for dealing with multi-dimensional arrays. Related to gh-16075
* | | Merge pull request #15769 from seberg/hugepages-allow-togglingMatti Picus2020-05-032-0/+86
|\ \ \ | | | | | | | | ENH: Allow toggling madvise hugepage and fix default
| * | | Further DOC-Fixup base don Ross' reviewSebastian Berg2020-03-181-16/+16
| | | |
| * | | Apply suggestions from code review by RossSebastian Berg2020-03-171-10/+10
| | | | | | | | | | | | Co-Authored-By: Ross Barnowski <rossbar@berkeley.edu>
| * | | DOC: Note few global global options we currently have in refdocsSebastian Berg2020-03-172-0/+86
| | |/ | |/| | | | | | | | | | These are options that are controlled typically through environment variable at startup or compile time.
* | | DOC: Added page describing how to contribute to the docs team (#16069)Melissa Weber Mendonça2020-05-031-1/+1
| | |
* | | DOC: Moved timeit examples under relevant bullet point.Ross Barnowski2020-04-251-11/+12
| | |
* | | DOC,BLD: Limit timeit iterations in random docs.Ross Barnowski2020-04-251-6/+6
| |/ |/| | | | | | | | | | | | | | | | | Limiting the number of loops performed in the %timeit evaluation results in a ~20% speedup in the time it takes to build the documentation. The results of the "benchmarking" are less accurate from the limited number of evaluations, but the relationship between the timing between the legacy and Generator sampling methods is preserved.
* | DOC: Add missing bracket (gh-16051)Chunlin2020-04-251-1/+1
| | | | | | Add missing closing brackets, script to generate the list in the PR gh-16051.
* | DOC: Clarify single-segment arrays in np reference (#16011)Anirudh Subramanian2020-04-221-0/+5
| | | | | | | | | | * Update doc/source/reference/arrays.ndarray.rst Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* | DOC: Update documentation w.r.t. NPY_RELAXED_STRIDES_CHECKING (gh-15907)Sebastian Berg2020-04-101-4/+6
| | | | | | | | This has been the default for a very long time, so this was incorrect and mentioning any versions is probably not helpful.
* | Merge pull request #15749 from panpiort8/masked_array_docsMatti Picus2020-04-041-1/+1
|\ \ | | | | | | DOC: document inconsistency between the shape of data and mask in numpy.ma
| * | Update doc/source/reference/maskedarray.baseclass.rstMatti Picus2020-04-041-1/+1
| | | | | | | | | Co-Authored-By: Sebastian Berg <sebastian@sipsolutions.net>
View Lorry Controller Status