summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | DOC: update roadmapRalf Gommers2020-06-011-39/+48
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Removes completed items and other outdated content, plus some things that are too detailed or not high-prio enough to be on the roadmap. Add new items that are being actively worked on or for which there's a lot of interest. Link the most relevant NEPs.
* | | | DEP: Deprecate inexact matches for mode, searchside (gh-16056)Anirudh Subramanian2020-06-081-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously misspelling were allowed by these functions as long as e.g. the first letter matched. They will now check whether the match is exact giving a deprecation warning when it is not. Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* | | | DOC: add release note about f2py threadsafetyPauli Virtanen2020-06-071-0/+4
| | | |
* | | | STY: trivial doc style fix in NEP 45. (#16514)Ralf Gommers2020-06-071-3/+4
| | | | | | | | | | | | Main purpose is to merge this and trigger a doc rebuild.
* | | | Merge pull request #16500 from bjnath/move_c_style_linkRalf Gommers2020-06-066-16/+18
|\ \ \ \ | | | | | | | | | | DOC: Point Contributing page to new NEP 45
| * | | | DOC: Add NEP45 and NEP29 targets, use <NEPxx> linksBen Nathanson2020-06-065-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Per gh-16500, changed link style to :ref:`<NEPxx>`. Added a NEP45 target to NEP 45, and added a NEP29 target to NEP 29 since it has the irregular NEP0029 target. The two new NEP targets aren't picked up, though the older ones are. Tried make clean in neps and docs. ``` /home/bjn/numpy_git/numpy-1/doc/source/dev/index.rst:191: WARNING: undefined label: nep45 (if the link has no caption the label must precede a section header) HOWTO_RELEASE.rst.txt:43: WARNING: undefined label: nep29 (if the link has no caption the label must precede a section header) HOWTO_RELEASE.rst.txt:50: WARNING: undefined label: nep29 (if the link has no caption the label must precede a section header) ``` The nep objects.inv does seem to have both the nep29 and nep44 targets.
| * | | | DOC: Use intersphinx for NEP referencesBen Nathanson2020-06-043-12/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Per #16500 discussion, adds link updates to PR. Replaces NEP URLs with intersphinx links in these files: * doc/HOWTO_RELEASE.rst.txt * doc/source/dev/howto-docs.rst * numpy/doc/dispatch.py * numpy/lib/format.py and incorporates @rossbar's #16502 change of `config.py`.
| * | | | DOC: Point Contributing page to new NEP 45Ben Nathanson2020-06-042-3/+3
| | |/ / | |/| | | | | | | | | | | | | | | | | | Moved the link for C style to NEP 45. In NEP 45, replaced explicit link to PEP 7 with a :pep: link.
* | | | DOC: Fixes for 18 broken links (#16472)bjnath2020-06-0613-45/+39
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-043-3/+34
|\ \ \ | | | | | | | | 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.
| * | | ENH: Improved __str__, __format__ for polynomialsRoss Barnowski2020-05-071-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changes the printing style of instances of the convenience classes in the polynomial package to a more "human-readable" format. __str__ has been modified and __format__ added to ABCPolyBase, modifying the string representation of polynomial instances, e.g. when printed. __repr__ and the _repr_latex method (which is used in the Jupyter environment are unchanged. Two print formats have been added: 'unicode' and 'ascii'. 'unicode' is the default mode on *nix systems, and uses unicode values for numeric subscripts and superscripts in the polynomial expression. The 'ascii' format is the default on Windows (due to font considerations) and uses Python-style syntax to represent powers, e.g. x**2. The default printing style can be controlled at the package-level with the set_default_printstyle function. The ABCPolyBase.__str__ has also been made to respect the linewidth printoption. Other parameters from the printoptions dictionary are not used. Co-Authored-By: Warren Weckesser <warren.weckesser@gmail.com> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* | | | DOC: NEP for C style guide (#16430)bjnath2020-06-042-210/+263
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: NEP for C style guide Draft of NEP 45 setting code style for NumPy C code, using the wording of doc/C_STYLE_GUIDE.rst.txt
* | | | Merge pull request #16465 from bjnath/dev_workflow_link_fixRalf Gommers2020-06-012-11/+11
|\ \ \ \ | |_|/ / |/| | | DOC: Fix development_workflow links
| * | | DOC: Fix development_workflow linksBen Nathanson2020-06-012-11/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixed links for branch delete and graph visualizer. Updated instructions for branch delete (git since 1.7.0 (Sept 2010) has allowed --delete sted ':'). 'Learn git' link pointed to Bitbucket instructions; replaced with GitHub instructions. Minor rewording in 'Pushing changes to the main repo'. This is NOT a review of the page, only some fixes.
* | | | Merge pull request #16306 from seberg/troubleshooting-fix-envCharles Harris2020-05-311-4/+2
|\ \ \ \ | | | | | | | | | | DOC: Fix troubleshooting code snippet when env vars are empty
| * | | | DOC: Fix troubleshooting code snippet when env vars are emptySebastian Berg2020-05-201-4/+2
| | | | | | | | | | | | | | | | | | | | | | | | | The previous snippet worked fine, but not when the environment variables were completly empty.
* | | | | DEP: Deprecate passing shape=None to mean shape=()Eric Wieser2020-05-311-0/+7
| | | | | | | | | | | | | | | | | | | | This requires some minor tweaks in `np.random` because there the two have different meanings, with `()` meaning 0d array and `None` meaning scalar.
* | | | | Merge pull request #16447 from rgommers/make-showCharles Harris2020-05-311-1/+6
|\ \ \ \ \ | | | | | | | | | | | | DOC: add a "make show" command to doc/Makefile
| * | | | | DOC: add a "make show" command to doc/MakefileRalf Gommers2020-05-311-1/+6
| | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Opens the front page of the docs built with `make html` in the default web browser. Idea copied from SciPy [ci skip]
* | | | | DOC: Add a NEP link to all neps.Matthias Bussonnier2020-05-3040-21/+87
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Usefull for crossreferencing and intersphinx Here is a snippet to update it if other neps are missing it: In [1]: neps = !ls nep-0* ...: for nep in neps: ...: number = nep[6:8] ...: with open(nep, 'r') as f: ...: data = f.read() ...: ...: if f'.. _NEP{number}:' in data: ...: continue ...: with open(nep, 'w') as f: ...: f.write('.. _NEP'+number+':\n') ...: f.write(data) ...:
* | | | Merge pull request #16365 from WarrenWeckesser/tweak-doc-makefileCharles Harris2020-05-301-1/+1
|\ \ \ \ | | | | | | | | | | DOC: Fix an obvious mistake in a message printed in doc/Makefile.
| * | | | DOC: Fix an obvious mistake in a message printed in doc/Makefile.Warren Weckesser2020-05-241-1/+1
| | | | |
* | | | | Update nep-0029-deprecation_policy.rstMatthias Bussonnier2020-05-291-1/+1
| | | | |
* | | | | DOC: Add a reference into NEP 29,Matthias Bussonnier2020-05-291-0/+2
| |_|/ / |/| | | | | | | | | | | | | | | | | | | use the same reference format as other NEP having reference, (uppercase NEP, and on the first line of the document). This make it easier to link to this NEP with intersphinx.
* | | | Merge pull request #16428 from bjnath/add-style-guideRalf Gommers2020-05-291-0/+7
|\ \ \ \ | | | | | | | | | | DOC: Add style guide to howto_document
| * | | | DOC: Add style guide to howto_documentBen Nathanson2020-05-291-0/+7
| | | | | | | | | | | | | | | | | | | | Fixes gh-16262
* | | | | DOC: remove "Provisional" from NEPs overview if no NEPs have that statusRalf Gommers2020-05-292-1/+9
| | | | |
* | | | | DOC: change NEP 18 status to FinalRalf Gommers2020-05-291-1/+1
|/ / / /
* | | | DOC,BLD: Update sphinx conf to use xelatex.Ross Barnowski2020-05-271-0/+3
| | | | | | | | | | | | | | | | | | | | Switch from pdflatex to xelatex as the latex engine used for generating the latex/pdf version of the documentation.
* | | | Merge pull request #15900 from seberg/deprecate-empty-indexing-errorMatti Picus2020-05-281-0/+16
|\ \ \ \ | | | | | | | | | | DEP: Ensure indexing errors will be raised even on empty results
| * | | | DEP: Ensure indexing errors will be raised even on empty resultsSebastian Berg2020-05-271-0/+16
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, when the indexing result was empty, no check was done for backward compatibility with pre 1.9 (assumingly). This may have been only necessary when the outer iteration is empty as opposed to when just the inner iteration is empty, though. In any case, it is arguably buggy to ignore indexing errors in this case. Since there may have been a reason back in the day, and this is probably extremely rare, optiming for a brief deprecation period for now. Closes gh-15898 Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Matti Picus <matti.picus@gmail.com>
* | | | DOC,BLD: Update make dist html target.Ross Barnowski2020-05-271-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Switch html target for make dist to move away from the html-scipyorg theme. Makes the theme of the archived docs including stable consistent with the devdocs
* | | | MAINT,DOC: add index for user docs. (#16373)Ross Barnowski2020-05-271-0/+26
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | * MAINT,DOC: add index for user docs. Adds an index.rst for the user documentation (pre-NEP 44) to serve as a start page for the latex version of the user documentation. Marked as an orphan, so should not interfere with building html docs
* | | DOC: Reconstruct Testing Guideline. (#16323)Chunlin2020-05-231-50/+71
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * reconstruct testing doc * Update doc/TESTS.rst.txt * DOC: add docstring for numpy.test Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Matti Picus <matti.picus@gmail.com>
* | | BUILD: Remove Accelerate support (#15759)Matti Picus2020-05-222-4/+6
| | | | | | | | | | | | | | | | | | | | | Remove support for Apple Accelerate, since it is buggy. A build error should occur on most or all setups if linked against Accelerate. Test or import failures should occur on setups where Accelerate is picked up dynamically. Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
* | | DOC: Fix spelling typo - homogenous to homogeneous. (#16324)Kevin Moore2020-05-214-5/+5
| | |
* | | DOC: Correct documentation of ``__array__`` when used as output array. (#16130)Tina Oberoi2020-05-211-3/+2
| | |
* | | MAINT: Bumpy numpydoc version.Ross Barnowski2020-05-201-0/+0
|/ / | | | | | | | | | | | | Fixes problem with citation (reference) anchors in rendered docs. Actual fix was in numpy/numpydoc@7c42883, but this bumps to latest (unreleased) numpydoc version.
* | Merge pull request #15997 from panpiort8/array_pretty_printMatti Picus2020-05-201-0/+12
|\ \ | | | | | | ENH: improve printing of arrays with multi-line reprs
| * | Update doc/release/upcoming_changes/15997.improvement.rstpanpiort82020-05-201-4/+12
| | | | | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * | Improve the snippetPan Jan2020-05-201-3/+4
| | |
| * | Move the snippet notePan Jan2020-05-193-12/+4
| | |
| * | Add release note snippetPan Jan2020-05-072-1/+12
| | |
* | | Merge pull request #16156 from WarrenWeckesser/deprecate-dualSebastian Berg2020-05-192-1/+6
|\ \ \ | | | | | | | | DEP: Deprecate `numpy.dual`.
| * | | REL: Add a release note about the deprecation of numpy.dual.Warren Weckesser2020-05-051-0/+5
| | | |
| * | | 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
* | | | Merge pull request #16257 from WarrenWeckesser/doc-glue-f2pySebastian Berg2020-05-181-22/+29
|\ \ \ \ | | | | | | | | | | DOC: Update the f2py section of the "Using Python as Glue" page.
| * | | | DOC: A few small changes in the "Using Python as Glue" page.Warren Weckesser2020-05-181-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | * Fix whitespace in the inputs to Python in the f2py examples. * Capitalize Python and Fortran consistently.
View Lorry Controller Status