[docs]: The "Edit Page" button is not visible in the documentation for the stable branch.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Documentation
while fixing issue #17870 , I opened the PR #17933 , after the merge of that PR, I noticed the following behavior:
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.
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.
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by reviewing the Sphinx documentation deployment configuration for the latest and stable branches, then determine whether stable-tagged documentation should expose an edit path. Done requires an agreed behavior and a documented implementation scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100