Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[docs]: fix the edit page buttton link in docs#17933

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
hauntsaninja merged 3 commits intopython:masterfromMr-Sunglasses:fix/17870
Oct 14, 2024

Conversation

@Mr-Sunglasses
Copy link
Contributor

(Explain how this PR changes mypy.)

fix:#17870

Issue

The current docsedit the page button gives a 404.

What changes this PR does

This PR edits the sphinxconfig.py and configures the edit button url to themaster branch of this repository.

Copy link
Collaborator

@hauntsaninjahauntsaninja left a comment

Choose a reason for hiding this comment

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

Hm, I couldn't find a reference for these options. Is there one?

@Mr-Sunglasses
Copy link
ContributorAuthor

Mr-Sunglasses commentedOct 14, 2024
edited
Loading

Hm, I couldn't find a reference for these options. Is there one?

Yeah, I take the reference from cpython devguide repohere and the docs for the furo themehere

Copy link
Collaborator

@hauntsaninjahauntsaninja left a comment

Choose a reason for hiding this comment

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

Thanks for the fix and the link! :-)

Mr-Sunglasses reacted with laugh emoji
@hauntsaninjahauntsaninja merged commit80b5913 intopython:masterOct 14, 2024
@Mr-Sunglasses
Copy link
ContributorAuthor

Mr-Sunglasses commentedOct 14, 2024
edited
Loading

@hauntsaninja Quick question about how the docs are currently working after the recent PR merge. The current behavior of the docs site is as follows:

When we view the latest branch, the "Edit" button is visible. This happens because Sphinx uses the GitHub repository link combined with the branch name to allow editing the specific source file of the documentation.

Screenshot 2024-10-15 at 2 24 58 AM

However, when we switch to the stable branch, the "Edit" button disappears. This is expected behavior with Sphinx since the stable docs are released using tags, and tagged releases aren't associated with branches that can be directly edited.

Screenshot 2024-10-15 at 2 25 06 AM
Screenshot 2024-10-15 at 2 53 42 AM

IMO, we need to further discuss whether this is the behavior we want or if we need to consider changing how we deploy our docs.

@hauntsaninja
Copy link
Collaborator

Feel free to open an issue or more PRs if you have some improvements you'd like to make! :-)
I'm not particularly knowledgeable about sphinx / rtd, so don't have any opinions

Mr-Sunglasses reacted with thumbs up emoji

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@hauntsaninjahauntsaninjahauntsaninja approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

An edit button in docs does not work (gives 404)

2 participants

@Mr-Sunglasses@hauntsaninja

[8]ページ先頭

©2009-2025 Movatter.jp