-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
DOC: fix references in docs #13104
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
DOC: fix references in docs #13104
Conversation
Hey can I work on this? |
Anyone is welcome to work on this. You should read up on building the documentation and then
|
can you get rid of that somehow @mattip? |
We should merge this as-is, it improves the current situation. I opened #13114 with the content of the first comment for more work. |
Merged, thanks @mattip |
for the record, TravisCI did complete, it just failed to report its status back to this PR |
I've observed that in a few places when using the official Draft Status mode for PRs. |
I followed the steps written, but I got error in conf.py
I guess I know what the error is about. On line 132 in conf.py
with this helps.
|
The error here is supposed to guide you how to solve the problem: try running |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
clean work!
Turning on
-n
insphinx-build
results in over 1000 warnings about bad references in docs. Trying to break these down with various grep statements, it seems about 200 are fromnumpy.ma
, about 150 frompolynomial
and about 150 fromc:type
. That is under half of the WARNINGS.My workflow is to run
and look for the most common lines. Unfortunately this takes quite a while.
Anyone who wishes to contribute can issue PRs against the
doc-references
branch in numpy/mattip. I have marked this as Easy since many of the WARNINGS are quite easy to fix. The first commit gives an idea of some of the problems in the c-api documentation.Reviewers can get an idea of how bad things are by looking at the circle-ci devdoc build step.