Skip to content
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

Switch to a branded/customised version of sphinx-book-theme #128

Merged
merged 6 commits into from
Apr 12, 2022

Conversation

ptheywood
Copy link
Member

@ptheywood ptheywood commented Mar 21, 2022

Changes include:

  • Customised colours, including backgrounds, links, code highlighting etc
    • Uses a darkened N8 Orange to achieve meet a11y guidelines for contrast
  • Padding / margin customisations via CSS
  • RHEL 8 migration announcement, which can be easily removed or adjusted in the future.
    • relies on JS to correctly set the link, when the absolute path is not known at the right time.
  • Customised navigation search box with a submit button for a11y
  • Customised footer template to remove unwanted automatic content
    • Adds acknowledgement of Sphinx and The executable book project.

Also switches to the default pygments syntax highlighting theme which is one of the few with good contrast for a11y

Closes #87
Closes #80
Part of #42

Changes include:

* Customised colours, including backgrounds, links, code highlighting etc
  * Uses a darkened N8 Orange to achieve meet a11y guidelines for contrast
* Padding / margin customisations via CSS
* RHEL 8 migration announcement
  * relies on JS to correctly set the link, when the absolute path is not known at the right time.
* Customised navigation search box with a submit button for a11y
* Customised footer template to remove unwanted automatic content
  * Adds acknowledgement of Sphinx and The executable book project.

Also switches to the default pygments syntax highlighting theme which is one of the few with good contrast for a11y
@ptheywood
Copy link
Member Author

ptheywood commented Mar 21, 2022

Hosted demo (temporary): https://ptheywood.uk/bede-docs-demo-book/

image

@ptheywood ptheywood marked this pull request as ready for review March 24, 2022 19:49
@ptheywood ptheywood requested a review from a team March 24, 2022 19:49
@jsteyn jsteyn merged commit f88ff64 into main Apr 12, 2022
@ptheywood ptheywood deleted the sphinx-book-theme branch April 27, 2022 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Switch to (branded) alternate sphinx theme Anchors hidden by fixed navbar
2 participants