Skip to content
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

FEAT: link to source code on GitHub with linkcode #8

Merged
merged 2 commits into from
Dec 5, 2023
Merged

FEAT: link to source code on GitHub with linkcode #8

merged 2 commits into from
Dec 5, 2023

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Dec 5, 2023 •
edited
Loading

Closes ComPWA/policy#60

The sphinx_api_relink now automatically links to the source code on GitHub through the sphinx.ext.linkcode extension. You need to specify the GitHub organization and the repository name as follows:

api_github_repo: str = "ComPWA/sphinx-api-relink"

Set api_linkcode_debug = True to print the generated URLs to the console.

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Dec 5, 2023
@redeboer redeboer self-assigned this Dec 5, 2023
@redeboer redeboer marked this pull request as ready for review December 5, 2023 21:07
@redeboer redeboer merged commit d80f6c2 into main Dec 5, 2023
7 checks passed
@redeboer redeboer deleted the linkcode branch December 5, 2023 21:08
This was referenced Dec 5, 2023
Merged
Merged
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@redeboer redeboer

Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Switch to sphinx.ext.linkcode extension
1 participant
@redeboer