Thanks to visit codestin.com
Credit goes to github.com

Skip to content

"Contributing to NumPy" links not rendering? #13740

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.

Sign up for GitHub

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

Jump to bottom
Closed
mdhaber opened this issue Jun 8, 2019 · 5 comments · Fixed by #13799
Closed

"Contributing to NumPy" links not rendering? #13740

mdhaber opened this issue Jun 8, 2019 · 5 comments · Fixed by #13799
Labels
00 - Bug component: documentation

Comments

@mdhaber
Copy link
Contributor

mdhaber commented Jun 8, 2019 •
edited
Loading

Contributing to NumPy has some text that is probably intended to render as hyperlinks but doesn't. Instead, it just appears in italics:

Commit locally as you progress (git add and git commit) Use a properly formatted commit message, write tests that fail before your change and pass afterward, run all the tests locally. Be sure to document any changed behavior in docstrings, keeping to the NumPy docstring standard.

From numpy/doc/source/dev/index.rst:

Commit locally as you progress (``git add`` and ``git commit``)
     Use a `properly formatted <writing-the-commit-message>` commit message,
     write tests that fail before your change and pass afterward, run all the
     `tests locally <development-environment>`. Be sure to document any
     changed behavior in docstrings, keeping to the NumPy docstring
     `standard <howto-document>`.

There are many other instances throughout the document (which is otherwise great, BTW).
@eric-wieser
Copy link
Member

cc @mattip: I thought we made it a build error when this type of thing happens.

@kritisingh1
Copy link
Member

I think there is some problem with the markdown. We need a _ after the backticks to turn the text into a link. Thanks @mdhaber for pointing it out. Fixing.

@mattip
Copy link
Member

mattip commented Jun 9, 2019

We have not yet turned on -n when building documentation, which would fail on bad internal references.

@rgommers
Copy link
Member

We have not yet turned on -n when building documentation, which would fail on bad internal references.

Which kind of internal references? If you are referring to single backticks for parameters/returns, that should not be relevant - just copy the SciPy setup for turning on warning detection. If it's about broken links between packages, then it seems kind of important to fix those (and there can't be that many right?).

@mattip
Copy link
Member

mattip commented Jun 10, 2019

single backticks are used (and fail) all over the documentation. Turning on the warning detection SPHINXOPTS='-n' make html results in over 1000 warnings. See also issue #13114

@kritisingh1 kritisingh1 mentioned this issue Jun 18, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
00 - Bug component: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Fix unrendered links kritisingh1/numpy
5 participants
@rgommers @eric-wieser @mattip @mdhaber @kritisingh1