Skip to content

Doc linkcode tuning #2854

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
Merged
merged 4 commits into from
Jan 11, 2022
Merged

Doc linkcode tuning #2854

merged 4 commits into from
Jan 11, 2022

Conversation

Bibo-Joshi
Copy link
Member

make the [source] anchors point to the correct file on github wherever reasonably possible, including the correct line numbers and the correct blob. I chose the output of git describe --tags here as it

  • makes sure that on dev branches we don't point to master
  • makes sure to point directly to the corresponding tag when building from a release commit

A build of this branch is up at https://python-telegram-bot.readthedocs.io/en/doc-linkcode-tuning/

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Jan 11, 2022
@Bibo-Joshi Bibo-Joshi requested a review from harshil21 January 11, 2022 17:38
harshil21
harshil21 approved these changes Jan 11, 2022
View reviewed changes
Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! I definitely wouldn't have thought of using an unrelated function to achieve this.

@Bibo-Joshi Bibo-Joshi merged commit 60c5a52 into doc-fixes Jan 11, 2022
@Bibo-Joshi Bibo-Joshi deleted the doc-linkcode-tuning branch January 11, 2022 18:56
@github-actions github-actions bot locked and limited conversation to collaborators Jan 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@harshil21 harshil21 harshil21 approved these changes

Assignees
No one assigned
Labels
⚙️ documentation affected functionality: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Bibo-Joshi @harshil21