8000 DOC: link to governance, convert external link to internal by mattip · Pull Request #10980 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: link to governance, convert external link to internal #10980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2018

Conversation

mattip
Copy link
Member
@mattip mattip commented Apr 26, 2018

one more doc cleanup pull request. This:

  • removes a recursive link
  • adds a link to the governance document from the about page
  • refactors an external link to an internal one

@@ -1,7 +1,7 @@
About NumPy
===========

`NumPy <http://www.scipy.org/NumpPy/>`__ is the fundamental package
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link had a typo in it anyway!

@@ -42,6 +42,8 @@ Our main means of communication are:

More information about the development of NumPy can be found at our `Developer Zone <https://scipy.scipy.org/scipylib/dev-zone.html>`__.

The project management structure can be found at our `governance page <dev/governance/index.html>`__
Copy link
Member
@eric-wieser eric-wieser Apr 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this really need the .html? Won't that make it fail if rendered using a different sphinx renderer?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed and squashed

@@ -18,7 +18,7 @@ Before reading this, it may help to familiarize yourself with the basics
of C extensions for Python by reading/skimming the tutorials in Section 1
of `Extending and Embedding the Python Interpreter
<http://docs.python.org/extending/index.html>`_ and in `How to extend
NumPy <http://docs.scipy.org/doc/numpy/user/c-info.how-to-extend.html>`_
NumPy <c-info.how-to-extend.html>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guessing this .html can be stripped too?

Is there any easy way to check the rendered docs for PRs like this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed and squashed, good catch. The html generates a valid http link in the document, so I don't know how we could catch it other than a grep,

grep "html>" -r . --include='*.rst' --include=*.py | grep -v http

now catches only the internal links to NEP docs, which are correct since they point to documents not rendered via the numpy repe

Copy link
Member
@eric-wieser eric-wieser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to know if it's possible to check the output of these CRs through CircleCI, but this looks correct to me anyway

@charris
Copy link
Member
charris commented Apr 27, 2018

Thanks Matti.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0