sphinx-rtd-theme-ext-color-contrast


Namesphinx-rtd-theme-ext-color-contrast JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/AaltoSciComp/sphinx_rtd_theme_ext_color_contrast/
Summarysphinx_rtd_theme extension to enhance color contrast
upload_time2024-03-24 20:15:57
maintainerNone
docs_urlNone
authorRichard Darst
requires_pythonNone
licenseNone
keywords sphinx-extension
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            sphinx-rtd-theme color contrast extension
=========================================

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AaltoSciComp/sphinx_rtd_theme_ext_color_contrast/",
    "name": "sphinx-rtd-theme-ext-color-contrast",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "sphinx-extension",
    "author": "Richard Darst",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/25/21/4404b46f2dbf1bb306246fe713f8c25fa730ffdf0e1c93a41cca99cbe959/sphinx_rtd_theme_ext_color_contrast-0.3.2.tar.gz",
    "platform": null,
    "description": "sphinx-rtd-theme color contrast extension\n=========================================\n\nThis increases some color contrast in sphinx_rtd_theme to better\nsatisfy web content accessibility guidelines.  This is by no means a\nproper fix, but some quick hacks by an uneducated person.  It tries to\nmake minimal changes, though.\n\nThis package will be deprecated once sphinx_rtd_theme is improved\nupstream: https://github.com/readthedocs/sphinx_rtd_theme/issues/971\n\nCurrently it is not on PyPI (but could be), because I am hoping\nsphinx_rtd_theme will be updated before that is necessary.  To\ninstall, add this to ``requirements.txt``::\n\n  https://github.com/AaltoSciComp/sphinx_rtd_theme_ext_color_contrast/archive/master.zip\n\nAnd then add the extension in ``conf.py``::\n\n  extensions = [\n     ...\n     'sphinx_rtd_theme_ext_color_contrast',\n  ]\n\nStyle changes\n-------------\n\nText contrast:\n\n- Increase link text saturation\n- Increase literal text saturation\n- Increase footer contrast\n\nUpdate pygments elements for contrast\n\nAdmonition colors\n\n- Make the admonition title backgrounds darker.\n- These are very long CSS selectors, copied from what the current\n  theme uses.\n\nMake the sidebar background darker\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "sphinx_rtd_theme extension to enhance color contrast",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/AaltoSciComp/sphinx_rtd_theme_ext_color_contrast/"
    },
    "split_keywords": [
        "sphinx-extension"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a877a0d72dec3aea71a035f6cc4016a09ba5861e312ed084b1d16d02e962fb4",
                "md5": "7ed4a9824592e1d21933dea219fb86da",
                "sha256": "fa661dea8d832bb1ba9d5dfb4c0b569890353732b0d7aabffc9cf65eb3b943ba"
            },
            "downloads": -1,
            "filename": "sphinx_rtd_theme_ext_color_contrast-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7ed4a9824592e1d21933dea219fb86da",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5300,
            "upload_time": "2024-03-24T20:15:56",
            "upload_time_iso_8601": "2024-03-24T20:15:56.232891Z",
            "url": "https://files.pythonhosted.org/packages/4a/87/7a0d72dec3aea71a035f6cc4016a09ba5861e312ed084b1d16d02e962fb4/sphinx_rtd_theme_ext_color_contrast-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "25214404b46f2dbf1bb306246fe713f8c25fa730ffdf0e1c93a41cca99cbe959",
                "md5": "52fe634cfb20fa30e5f7838818e60f70",
                "sha256": "464a579ac030821a328ef485d712f9b0a4b57dcb8e3aab44515dedc1944662e3"
            },
            "downloads": -1,
            "filename": "sphinx_rtd_theme_ext_color_contrast-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "52fe634cfb20fa30e5f7838818e60f70",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4673,
            "upload_time": "2024-03-24T20:15:57",
            "upload_time_iso_8601": "2024-03-24T20:15:57.924988Z",
            "url": "https://files.pythonhosted.org/packages/25/21/4404b46f2dbf1bb306246fe713f8c25fa730ffdf0e1c93a41cca99cbe959/sphinx_rtd_theme_ext_color_contrast-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-24 20:15:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AaltoSciComp",
    "github_project": "sphinx_rtd_theme_ext_color_contrast",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "sphinx-rtd-theme-ext-color-contrast"
}
        
Elapsed time: 4.30401s