summaryrefslogtreecommitdiff
path: root/doc/source/user
Commit message (Collapse)AuthorAgeFilesLines
...
* | Merge pull request #17391 from bjnath/doc-conventionsCharles Harris2020-10-051-2/+5
|\ \ | | | | | | DOC: Replace "About NumPy" with "Document conventions"
| * | DOC: Replace "About NumPy" with "Document conventions"Ben Nathanson2020-09-281-2/+5
| | | | | | | | | | | | | | | | | | | | | Eliminates the unhelpful "About NumPy" title. All contents of the original appear more prominently elsewhere, except for the information about document conventions, which is now the title and subject.
* | | Incorporate feedback from review.Ross Barnowski2020-09-291-4/+7
| | |
* | | DOC: rm incorrect alias from recarray user article.Ross Barnowski2020-09-291-1/+1
|/ /
* | Minor grammatical correction in quickstart doc.Jack2020-09-271-1/+1
|/ | | Single sentence grammatical correction.
* DOC: Revise #17352 with @mattip suggestionsBen Nathanson2020-09-221-11/+15
|
* DOC: Add how-to index entry for how-to guide PR #17352Ben Nathanson2020-09-212-2/+1
|
* DOC: How-to guide for drafting how-tosBen Nathanson2020-09-181-0/+116
| | | | Migrated from numpy-tutorials
* BLD: enabled negation of library choices in NPY_*_ORDER (#17219)Nick R. Papior2020-09-171-0/+21
| | | | | | | | | | | | | | | | | | | | | | | BLD: enabled negation of library choices in NPY_*_ORDER When users build for a particular order it may be beneficial to disallow certain libraries. In particular a user may not care about which accelerated BLAS library is used, so long as the NetLIB or ATLAS library isn't used. This is now possible with: NPY_BLAS_ORDER='^blas,atlas' or NPY_BLAS_ORDER='!blas,atlas' Since we may envision more BLAS/LAPACK libraries to the pool, this will provide greater flexibility as they enter. A new (local) method is added in system_info.py which removes duplicate code and allows for easier usage across libraries.
* DOC: Update numpy4matlab (#17159)Ryan C Cooper2020-09-151-317/+420
| | | | | | | * Update doc/source/user/numpy-for-matlab-users.rst Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Ben Nathanson <github@bigriver.xyz> Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
* MAINT, DOC: move informational files from numpy.doc.*.py to their *.rst ↵Matti Picus2020-09-0211-24/+3138
| | | | | | | | | counterparts (#17222) * DOC: redistribute docstring-only content from numpy/doc * DOC: post-transition clean-up * DOC, MAINT: reskip doctests, fix a few easy ones
* DOC: Use official MATLAB spelling in numpy-for-matlab-users.rst (gh-17215)Ryan C Cooper2020-09-021-34/+34
| | | | | | | | | | | | | | | | | | | * remove (R) from all MATLAB mentions except the first * Update doc/source/user/numpy-for-matlab-users.rst update the MATLAB case L53 Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * change case of all M/matlab to MATLAB * Update doc/source/user/numpy-for-matlab-users.rst replace (R) in reference to Mathworks reference Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC: Fixed headings for tutorials so they appear at new theme sidebar.MelissaWM2020-08-312-21/+42
|
* DOC: first step toward switching themesmattip2020-08-141-0/+17
|
* DOC: Fixes duplication of toctree content (Closes #17077)MelissaWM2020-08-131-5/+1
|
* Created <accelerated-blas-lapack-libraries> label in building.rstBrandon David2020-07-111-0/+2
|
* [DOC] Added tutorial about the numpy.ma module. (#15791)Melissa Weber Mendonça2020-06-303-0/+492
| | | Added tutorial about the numpy.ma module.
* DOC: updated gcc minimum recommend version to build from source (#16683)Hugo Mendes2020-06-261-1/+1
| | | * DOC: updated gcc minimum recommend version to build from source
* Merge pull request #16452 from mattip/accelerate-errorCharles Harris2020-06-111-0/+12
|\ | | | | DOC,ENH: extend error message when Accelerate is detected
| * Update doc/source/user/building.rstMatti Picus2020-06-111-1/+2
| | | | | | Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
| * Update doc/source/user/building.rstMatti Picus2020-06-111-1/+1
| | | | | | Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
| * DOC: add deprecation directivemattip2020-06-091-5/+6
| |
| * DOC: add comment about Acclerate, from reviewmattip2020-05-311-0/+6
| |
| * BUG: fix comment in RSTmattip2020-05-311-1/+1
| |
| * DOC,ENH: extend error message when Accelerate is detectedmattip2020-05-311-0/+4
| |
* | DOC: Fixes for 18 broken links (#16472)bjnath2020-06-062-7/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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 #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.
* | 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
* | BUILD: Remove Accelerate support (#15759)Matti Picus2020-05-221-4/+2
| | | | | | | | | | | | | | 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-211-2/+2
|/
* 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.
| * DOC: Update the f2py section of the "Using Python as Glue" page.Warren Weckesser2020-05-161-15/+22
| | | | | | | | * Update the output shown for the docstrings generated by f2py.
* | Merge pull request #16269 from tbm/typoMatti Picus2020-05-172-3/+3
|\ \ | |/ |/| DOC: Fix typos and cosmetic issues
| * DOC: Fix typos and cosmetic issuesMartin Michlmayr2020-05-172-3/+3
| |
* | DOC: Updated the f2py section of the "Using Python as Glue" page. (#16258)Siba Smarak Panigrahi2020-05-161-4/+4
|/ | | | * Replace print statements with print function calls. * Fix the filename in one of the commands: it is "add.f", not "add.f95".
* Merge pull request #16228 from anirudh2290/compilers_supported_docSebastian Berg2020-05-131-5/+5
|\ | | | | DOC: Add Clang and MSVC to supported compilers list
| * DOC: Add Clang and MSVC to supported compilers listAnirudh Subramanian2020-05-131-5/+5
| |
* | DOC: Add PyDev instructions to troubleshooting docRoss Barnowski2020-05-131-0/+8
|/
* DOC: Add VSCode help link to importerror troubleshootingSebastian Berg2020-05-031-3/+12
| | | | | | | | Adds the environment variable help link: https://code.visualstudio.com/docs/python/environments for VSCode. Closes gh-16139 and gh-15183
* Merge pull request #16014 from seberg/import-error-infoCharles Harris2020-05-012-0/+126
|\ | | | | DOC: Change import error "howto" to link to new troubleshooting page
| * Fix other comments from Ross and make it ImportError specificSebastian Berg2020-04-282-6/+6
| |
| * Apply suggestions from code reviewSebastian Berg2020-04-281-6/+5
| | | | | | Co-Authored-By: Ross Barnowski <rossbar@berkeley.edu>
| * DOC: Change import error "howto" to link to troubleshooting docsSebastian Berg2020-04-282-0/+127
| | | | | | | | | | | | | | | | | | This makes the C-API failed to load import error link to a new troubleshooting document in the user documentation. It links to the devdocs directly, since it should be possible to update the information at any time (e.g. when a new setup starts making issues). As these are not NumPy issues, their occurance is not tied to the NumPy release process.
* | trivial: Improve grammar on a comment in the quickstartgamboon2020-04-281-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This is a documentation change changing the following comment "this allows to have a 2D columns vector" to "view `a` as a 2D column vector" Rationale: - "allows to" and "columns vector" don't read well
* | 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: initialise random number generator before first use in quickstart (#16025)shreepads2020-04-221-2/+2
|/ | | | | | | | | | | * DOC: make random generator initialisation visible at the first point of use in the quickstart The random generator in the quickstart is initialised in a hidden test setup section at the start. This should be made visible at the first point of use so that new users don't get tripped up trying to set it up. Note that rg is also visibly initialised lower down in the Histogram section. Also moved another inline comment in the same example to ensure they are aligned as per the format used in the quickstart.
* DOC: add note on flatten ordering in matlab page (#16001)Pierre de Buyl2020-04-171-1/+2
| | | | | Add note on the ordering of matlab's ``x(:)`` vs NumPy ``x.flatten()`` fix #15837
* DOC, TST: enable refguide_check in circleci (#15848)Pierre de Buyl2020-03-292-2/+6
| | | | * DOC: fix traceback message to pass refguide_check * DOC, TST: add refguide_check to circleci