diff options
| author | bjnath <github@bigriver.xyz> | 2020-06-06 11:02:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-06 17:02:14 +0200 |
| commit | 9439b56f8762b8c9b48d2f9e54dfb467aaa2b3f9 (patch) | |
| tree | 2f373d4995ffec329f758c04e29447c456b02edb /doc/source/dev | |
| parent | f1671076c80bd972421751f2d48186ee9ac808aa (diff) | |
| download | numpy-9439b56f8762b8c9b48d2f9e54dfb467aaa2b3f9.tar.gz | |
DOC: Fixes for 18 broken links (#16472)
* 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
Diffstat (limited to 'doc/source/dev')
| -rw-r--r-- | doc/source/dev/gitwash/git_links.inc | 4 | ||||
| -rw-r--r-- | doc/source/dev/governance/governance.rst | 3 | ||||
| -rw-r--r-- | doc/source/dev/howto-docs.rst | 4 | ||||
| -rw-r--r-- | doc/source/dev/index.rst | 4 |
4 files changed, 7 insertions, 8 deletions
diff --git a/doc/source/dev/gitwash/git_links.inc b/doc/source/dev/gitwash/git_links.inc index 82e6c75e5..8032dca41 100644 --- a/doc/source/dev/gitwash/git_links.inc +++ b/doc/source/dev/gitwash/git_links.inc @@ -16,7 +16,7 @@ .. _subversion: http://subversion.tigris.org/ .. _git cheat sheet: http://cheat.errtheblog.com/s/git .. _pro git book: https://git-scm.com/book/ -.. _git svn crash course: https://git-scm.com/course/svn.html +.. _git svn crash course: https://git.wiki.kernel.org/index.php/GitSvnCrashCourse .. _learn.github: https://learn.github.com/ .. _network graph visualizer: https://github.blog/2008-04-10-say-hello-to-the-network-graph-visualizer/ .. _git user manual: https://www.kernel.org/pub/software/scm/git/docs/user-manual.html @@ -42,7 +42,7 @@ .. _why the -a flag?: http://www.gitready.com/beginner/2009/01/18/the-staging-area.html .. _git staging area: http://www.gitready.com/beginner/2009/01/18/the-staging-area.html .. _tangled working copy problem: https://tomayko.com/writings/the-thing-about-git -.. _git management: http://kerneltrap.org/Linux/Git_Management +.. _git management: https://web.archive.org/web/20090328043540/http://kerneltrap.org/Linux/Git_Management .. _linux git workflow: https://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html .. _ipython git workflow: https://mail.python.org/pipermail/ipython-dev/2010-October/005632.html .. _git parable: http://tom.preston-werner.com/2009/05/19/the-git-parable.html diff --git a/doc/source/dev/governance/governance.rst b/doc/source/dev/governance/governance.rst index d8719700f..9209f26b7 100644 --- a/doc/source/dev/governance/governance.rst +++ b/doc/source/dev/governance/governance.rst @@ -387,8 +387,7 @@ Acknowledgements ================ Substantial portions of this document were adapted from the -`Jupyter/IPython project's governance document -<https://github.com/jupyter/governance/blob/master/governance.md>`_. +`Jupyter/IPython project's governance document <https://github.com/jupyter/governance>`_ License ======= diff --git a/doc/source/dev/howto-docs.rst b/doc/source/dev/howto-docs.rst index 0e2e03e0b..281f87cfb 100644 --- a/doc/source/dev/howto-docs.rst +++ b/doc/source/dev/howto-docs.rst @@ -87,7 +87,7 @@ check out the following specific guides: Major additions to the documentation (e.g. new tutorials) should be proposed to the `mailing list <https://mail.python.org/mailman/listinfo/numpy-discussion>`__. - + Other ways to contribute ------------------------ @@ -145,5 +145,5 @@ the quality of the documentation. resources for technical writing. - Google offers two free `Technical Writing Courses <https://developers.google.com/tech-writing>`__ -- `Software Carpentry <https://software-carpentry.org/software>`__ has a lot of +- `Software Carpentry <https://carpentries.github.io/curriculum-development/>`__ has a lot of nice recommendations for creating educational material. diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index 5270bfb77..fd735f453 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -256,7 +256,7 @@ From the ``doc/`` directory: git submodule update --init The documentation includes mathematical formulae with LaTeX formatting. -A working LaTeX document production system +A working LaTeX document production system (e.g. `texlive <https://www.tug.org/texlive/>`__) is required for the proper rendering of the LaTeX math in the documentation. @@ -291,4 +291,4 @@ The rest of the story NumPy-specific workflow is in :ref:`numpy-development-workflow <development-workflow>`. -.. _`mailing list`: https://mail.python.org/mailman/listinfo/numpy-devel +.. _`mailing list`: https://mail.python.org/mailman/listinfo/numpy-discussion |
