Skip to main content

sphinx_rtd_theme extension to enhance color contrast

Project description

This increases some color contrast in sphinx_rtd_theme to better satisfy web content accessibility guidelines. This is by no means a proper fix, but some quick hacks by an uneducated person. It tries to make minimal changes, though.

This package will be deprecated once sphinx_rtd_theme is improved upstream: https://github.com/readthedocs/sphinx_rtd_theme/issues/971

Currently it is not on PyPI (but could be), because I am hoping sphinx_rtd_theme will be updated before that is necessary. To install, add this to requirements.txt:

https://github.com/AaltoSciComp/sphinx_rtd_theme_ext_color_contrast/archive/master.zip

And then add the extension in conf.py:

extensions = [
   ...
   'sphinx_rtd_theme_ext_color_contrast',
]

Style changes

Text contrast:

  • Increase link text saturation

  • Increase literal text saturation

  • Increase footer contrast

Update pygments elements for contrast

Admonition colors

  • Make the admonition title backgrounds darker.

  • These are very long CSS selectors, copied from what the current theme uses.

Make the sidebar background darker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file sphinx_rtd_theme_ext_color_contrast-0.3.1.tar.gz.

File metadata

File hashes

Hashes for sphinx_rtd_theme_ext_color_contrast-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3262f311300cb2b0f50a90ec51f7b1e81f9d378c25e530f15f73d933716672c7
MD5 80a55aaba5623acf58a47bbd3ac527b2
BLAKE2b-256 880c581529c6451b015062d94e3798e7d7023db10ffbb54ed52d8b1d31033fa0

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_rtd_theme_ext_color_contrast-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_rtd_theme_ext_color_contrast-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9565a1872ba95452d77ee472866cc82ee24dfbae6ad37182ff7201bae1366f31
MD5 f44150bb65c3f2d568af58345b9b7ad0
BLAKE2b-256 281b33b60d101f30ff64b798d51a621cd80a30538135028d587f3aa69f0cbaf3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page