Repository navigation
doc: Use sphinx-phytec-theme and its badges extension - #118
Open
mschwan-phytec wants to merge 3 commits into
Open
mschwan-phytec wants to merge 3 commits into
mschwan-phytec wants to merge 3 commits into
Conversation
mschwan-phytec
force-pushed
the
wip-doc-badges
branch
2 times, most recently
from
October 13, 2026 08:06
58aa12c to
1e28edb
Compare
mschwan-phytec
marked this pull request as draft
October 16, 2026 13:19
The layout configuration reference describes the type, state and
release of each option as plain text. This is hard to scan and has to
be repeated by hand for every option.
Use the PHYTEC Sphinx theme from sphinx-phytec-theme instead of
sphinx_rtd_theme with a local copy of the stylesheet. The theme also
provides the "badges" extension with the roles :badge-type:,
:badge-state:, :badge-since: and :badge:. The since badge links to the
release notes. The link target is built from the config value
badges_release_notes_ref, a template for the reference label containing
the version, e.g. "release-{version}".
Keep the partup specific logo, favicon and the Read the Docs flyout
fixups. Install the theme from the tagged release in the documentation
requirements and list it as a documentation dependency.
Signed-off-by: Martin Schwan <m.schwan@phytec.de>
Use the badges extension of sphinx-phytec-theme to show the metadata of
each option in the layout configuration reference instead of plain text:
- Replace the "(type)" suffixes with type badges. Options accepting
multiple types get one badge per type.
- Add state badges for the options whose state is fixed.
- Replace the "Available since" paragraphs with since badges linking
to the release notes.
Clean entries must contain an offset and a size, so change "should" to
"must" in the description of the clean section accordingly.
Signed-off-by: Martin Schwan <m.schwan@phytec.de>
The styling of the Read the Docs flyout is part of the PHYTEC Sphinx theme now, so it does not have to be kept in partup anymore. Drop rtd-fixups.css and its entry in conf.py. Signed-off-by: Martin Schwan <m.schwan@phytec.de>
mschwan-phytec
force-pushed
the
wip-doc-badges
branch
from
October 20, 2026 09:24
1e28edb to
79403af
Compare
mschwan-phytec
changed the title
mschwan-phytec
marked this pull request as ready for review
October 20, 2026 09:25
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a local Sphinx extension that allows placing badges for the data type, requirement state and when the functionality got added. The "since" badges automatically create links to the changelog.