-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Point [SOURCE] documents to github #20673
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
Conversation
This looks good. I'm surprised that there ins't a built in sphinx option for this though.... |
Many of these links don't seem to go to the right place, though some of them do... |
Are these the ones that are deprecated? While I tested it, I saw those would go to the deprecation github page. Aside from that, also add_callback confuses the function with the docstring |
I only did a spot check, but starting from https://62590-1385122-gh.circle-artifacts.com/0/doc/build/html/api/axes_api.html |
So now those ones you spotted are fixed. I also checked around ~20 more of those, and they look ok as well. Edit: |
Great. Do you know why they were different? |
I noticed if not fn or fn.endswith('__init__.py'):
fn = inspect.getsourcefile(sys.modules[obj.__module__]) |
@QuLogic I added some extra |
PR Summary
Addresses #20557 to point the [SOURCE] in docs point to github instead. A proper build config to build the old way is still missing, but perhaps that can be part of separate PR. Also, this impl was copied from scipy conf.py, but modified slightly to work here instead.
PS: Building old way is just adding back the
sphinx.ext.viewcode
, but I was not sure how to add it as part of amake O=-Dmyarg=1 html
.PR Checklist
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).