-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-87378: [doc] Link to source #24521
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
base: main
Are you sure you want to change the base?
Conversation
You can test what this extension links each name to by pulling my fork git clone git@github.com:verhovsky/cpython.git
cd cpython
git pull
git checkout link-to-source
cd Doc then uncommenting the last 2 commented out rm -rf build/*
make html | tee >(grep -v "\s" > doesnt-exist) | tee >(grep -v "\.\.\. ." | grep "\s" > exists) creating two files
Currently 5058/9079 documented symbols would have a link to source: $ wc exists doesnt-exist
5058 31742 813825 exists
4021 4015 96125 doesnt-exist
9079 35757 909950 total Some reasons for stuff not getting linked:
This adds about 5 seconds to |
This PR is stale because it has been open for 30 days with no activity. |
d197173
to
7cbfb91
Compare
303b800
to
89819d9
Compare
8295105
to
1524000
Compare
1524000
to
3ba9ffe
Compare
3ba9ffe
to
9cd0223
Compare
cc. Sphinx experts @AA-Turner and @hugovk |
Thanks for the ping @erlend-aasland -- from my perspective this PR needs several architectural changes (not doing things in the module scope, at the least) -- likely larger than what can reasonably be achieved via the GH suggestions mechanism, so unless anyone objects I'd propose to push my suggested changes to this branch? A |
d41c25b
to
b09e2da
Compare
Links to source of classes and functions defined in Python or using the Argument Clinic using
sphinx.ext.linkcode
(available since Sphinx 1.1)https://bugs.python.org/issue43212