summaryrefslogtreecommitdiff
path: root/doc/source/dev
Commit message (Collapse)AuthorAgeFilesLines
* DOC: Fix typos (general documentation)Alexander Kuhn-Regnier2020-10-211-1/+1
|
* DOC: Added a PR "Reviewer guidelines" document. (#17252)Melissa Weber Mendonça2020-10-193-3/+130
|
* DOC: Fix empty 'C style guide' page (#17503)Ben Nathanson2020-10-092-10/+2
| | | | | Add external link to NEP45 in tocs of dev/index Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* Merge pull request #17448 from bjnath/rm-dupe-cocCharles Harris2020-10-043-385/+0
|\ | | | | DOC: Remove CoC pages from Sphinx
| * DOC: Remove CoC pages from SphinxBen Nathanson2020-10-043-385/+0
| | | | | | | | | | code_of_conduct.rst and report_handling_manual.rst duplicate pages now on Hugo.
* | DOC: Fixes for PR 17440Ben Nathanson2020-10-031-0/+2
| | | | | | | | | | | | Colon missing in heading. Added sphinx anchor for PR-timeline (html anchor was OK).
* | DOC: Cleaner PR templateBen Nathanson2020-10-031-9/+26
|/ | | | | | | | | | Make the instructions easy to see and hard to delete unread. Moves some text to new sections in dev/development_workflow.rst. The dashes above and below the heading, which in monospace seem too long, fit it well in Chromium browsers and reasonably in Firefox.
* DOC: work around a bug in the new thememattip2020-09-051-0/+16
|
* DOC: Amend gh-16757 to make Marten van Kerkwijk emeritusBen Nathanson2020-07-051-2/+2
|
* DOC: Add Matti Picus to steering council pageBen Nathanson2020-07-051-10/+13
| | | | | | | | | | | | | Per announcement in https://mail.python.org/pipermail/numpy-discussion/2020-June/080760.html. I've alphabetized the steering council names (some but not all had been alphabetized). Added diacritical mark in Stéfan. This page partially overlaps https://numpy.org/about/. Submitting a separate PR. I imagine at some point we want to transfer over the remaining contents of this older page and cleanly remove it.
* DOC: Simplify and update git setup page (gh-16671)bjnath2020-06-264-99/+132
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * DOC: Simplify and update git setup page Changed title from "Getting started with Git development" to more specific "Setting up git for NumPy development" Updated the outdated GitHub screenshot for forking button, added more screenshots. Simplified the narrative. Fixed bad github links (always pointed to NumPy's github). Clarified SSH setup, role, and effect on git remote -v. Clarified meaning of "upstream" and "origin". Replaced read of .git/config (platform-specific) with call to git config. * DOC: Add links, remove section from PR #16671 Per suggestion, removed outdated advice on getting pull branches. Added back rST anchors, should have left them in. * DOC: Add page anchor for PR #16671 Add '.. _development-setup:' page anchor.
* DOC: Tighten howto-docs guide #16259 (#16385)bjnath2020-06-111-129/+136
| | | * DOC: rreword much of the howto-docs guide
* Merge pull request #16500 from bjnath/move_c_style_linkRalf Gommers2020-06-062-5/+4
|\ | | | | DOC: Point Contributing page to new NEP 45
| * DOC: Add NEP45 and NEP29 targets, use <NEPxx> linksBen Nathanson2020-06-062-5/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-041-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | 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-041-2/+2
| | | | | | | | | | | | 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-064-8/+7
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* 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.
* DOC: improve development debugging doc (#16083)Chunlin2020-05-132-7/+21
| | | | | * improve development debugging doc Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* DOC: update people listed under Institutional PartnersRalf Gommers2020-05-101-2/+2
|
* DOC: update the Code of Conduct committee membersRalf Gommers2020-05-101-2/+2
| | | | | See https://mail.python.org/pipermail/numpy-discussion/2020-May/080625.html for the public discussion on this.
* DOC: Added page describing how to contribute to the docs team (#16069)Melissa Weber Mendonça2020-05-032-0/+152
|
* 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: Fixed order of items and link to mailing list in dev docs index. (#15901)Melissa Weber Mendonça2020-04-021-9/+8
| | | | | * Fixed order of items and link to mailing list. * Fixed link for github.
* DOC: First steps towards docs restructuring (NEP 44)Melissa Weber Mendonca2020-03-261-0/+7
|
* BLD: Add requirements.txt file for building docs (#15778)Ross Barnowski2020-03-191-0/+12
| | | * BLD: Added doc_requirements.txt and improve documentation around building docs
* DOC: Fix runtests example in developer docsAnirudh Subramanian2020-03-181-1/+1
|
* DOC: Added note about LaTeX requirementRoss Barnowski2019-12-291-0/+5
| | | | | Building the html docs from source requires a working LaTeX build environment to get the equations rendered properly.
* DOC: Initialize submodules to build docs.Ross Barnowski2019-12-291-0/+11
| | | | | | Added instructions to the developer guide on initializing the submodules containing numpydoc and the scipy sphinx theme before building the documentation.
* Fix typos, via a Levenshtein-style correctorBrian Wignall2019-12-192-2/+2
|
* DOC: document the NPY_AVAILABLE_MEM test mechanismPauli Virtanen2019-12-011-0/+10
|
* Fix typosBrian Wignall2019-11-251-1/+1
|
* Merge pull request #14732 from mattip/refguide-rstCharles Harris2019-11-231-1/+1
|\ | | | | TST: run refguide-check on rst files in doc/*
| * TST: run refguide-check on rst files in doc/*mattip2019-10-171-1/+1
| |
* | BUILD, DOC: remove the std=c99 flag from docs, builds, add release notemattip2019-10-251-2/+1
|/
* DOC: Note release notes process changes on devdocs start pageSebastian Berg2019-10-141-2/+5
|
* DOC: Note IPython requirement for doc build in development notes (#14649)David Stansby2019-10-061-1/+1
|
* DOC, BUILD: make build_src more discoverablemattip2019-09-201-0/+15
|
* DOC,MAINT: Move towncrier files and fixup categoriesSebastian Berg2019-08-121-2/+3
| | | | | | | | | Name all categories as singular (or adjectives). Also move the fragments into an ``upcoming_changes`` folder to be more discoverable. Notes that we format some things as bullet points traditionally (right now towncrier only truly supports bullet point format, but I have a PR to fix that).
* Merge pull request #14027 from rgommers/contributingRalf Gommers2019-08-081-0/+27
|\ | | | | DOC: update "Contributing to NumPy" with more activities/roles
| * DOC: finish "contributing to NumPy" edits - w private list and Slack.Ralf Gommers2019-08-061-3/+5
| |
| * WIP: DOC: update "Contributing to NumPy" with more activities/rolesRalf Gommers2019-07-161-0/+25
| |
* | Merge pull request #14069 from sameshl/doc_test_instructionsMatti Picus2019-08-081-0/+9
|\ \ | | | | | | DOC: Emphasize the need to run tests when building from source
| * | DOC: Emphasize the need to run tests when building from sourceSamesh2019-07-211-0/+9
| |/ | | | | | | | | | | Add note on testing in docs of "setting up dev envirnoment" and "building NumPy from source" closes #14037
* | Merge pull request #14089 from Carreau/no-setuppyRalf Gommers2019-07-251-4/+1
|\ \ | | | | | | DOC: Use `pip install .` where possible instead of calling setup.py
| * | Remove deprecated info about dev buildMatthias Bussonnier2019-07-251-3/+0
| | |
| * | Doc: Use `pip install .` where possible instead of calling setup.pyMatthias Bussonnier2019-07-231-2/+2
| |/ | | | | | | pip will itself call setup.py install with the rights options.
* | Merge pull request #13908 from mattip/towncrierSebastian Berg2019-07-241-16/+21
|\ \ | | | | | | ENH: use towncrier to build the release note
| * | ENH: use towncrier to build the release notemattip2019-07-241-16/+21
| |/
* | DOC: Update NumFOCUS subcommittee replacing Nathaniel with SebastianSebastian Berg2019-07-161-1/+1
|/ | | | | | | | I believe that we pretty much decided on this and @njsmith wished to not be the NumFOCUS liason, so this suggests to replace me and him for the subcommittee as well. This is up for discussion, if anyone else is interested I would be happy to exchange it and if Nathaniel wants to remain on the subcommittee we can go another route.
View Lorry Controller Status