Skip to content

[docs] Add Github repo icon-link to topbar #12462

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

Merged
merged 3 commits into from
Jun 22, 2024

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Jun 22, 2024

@chrisjsewell chrisjsewell requested a review from picnixz June 22, 2024 15:33
@chrisjsewell
Copy link
Member Author

cc @timhoffm

@chrisjsewell chrisjsewell changed the title [docs] Add Github Repo icon link to topbar [docs] Add Github Repo icon-link to topbar Jun 22, 2024
@chrisjsewell chrisjsewell changed the title [docs] Add Github Repo icon-link to topbar [docs] Add Github repo icon-link to topbar Jun 22, 2024
Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Don't we have this already with the RTD widget? do you want to duplicate it? Personally, I'd prefer having it in the footer rather at the top (it's a bit less intruisive)

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Jun 22, 2024

I'd prefer having it in the footer rather at the top (it's a bit less intruisive)

I'm afraid I must vehemently disagree here;
the whole point is to make it prominent, and obvious to users how to navigate to the source repository.
I can point to a multitude of OSS based tools/libraries that use this convention in their documentation, in fact it is hard to find any that do not 😅

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Ok, I'm in.

@chrisjsewell
Copy link
Member Author

Ok, I'm in.

Thanks 😄

and BTW thanks for all the quick reviews, let me know if you have any PRs outstanding I should be looking at!

@chrisjsewell chrisjsewell merged commit a1bb165 into sphinx-doc:master Jun 22, 2024
7 checks passed
@chrisjsewell chrisjsewell deleted the docs-gh-icon branch June 22, 2024 18:48
@timhoffm
Copy link
Contributor

Thanks, this is an improvement. 👍 As a feedback, I've been looking for a GitHub link from inside the docs multiple times. It was something like "Contribute -> Contribute Code -> Find a link somewhere in a paragraph of text".

@picnixz
Copy link
Member

picnixz commented Jun 22, 2024

and BTW thanks for all the quick reviews, let me know if you have any PRs outstanding I should be looking at!

No problem! the only PR that is still waiting for rewiew is #12219 but this is a huge one. If you have a bit of time, then I don't mind. Most of my ongoing PRs are in CPython currently.

@AA-Turner AA-Turner added this to the 7.4.0 milestone Jul 13, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants