sphinx-doc / sphinx-doc/sphinx

Add page override for previous/next links via metadata

Open
#9,024 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:enhancement
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
Reading the documentation of Blender, in the building documentation with Linux page I've found that the next button link it's pointing to the building documentation page with MacOs. It would be cool an option to point to other page on previous and next buttons on a single page, so in this case the next button would point to edit manual blender documentation page and the Continue with the next step: Editing. last line could be consistent with Next button.

Describe the solution you'd like
A user should be able to use Special metadata fields to override the previous and next page.

Describe alternatives you've considered
This could be implemented on a theme level for example: https://github.com/readthedocs/sphinx_rtd_theme/pull/995
However, it would be nice if this was a core feature.

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Sphinx's linked documentation for special metadata fields, then review the referenced sphinx_rtd_theme pull request and issue for prior design context. Implement and verify metadata-based overrides for a page's previous and next links, including the Blender documentation example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.