rtd_theme_addons

Patches the Read The Docs Sphinx Theme.

Warning

These modifications only work in the Read The Docs Theme

Note

Extension is automatically loaded when added to extensions, no directives or configurations required.

Modifications:

  1. Permit nested admonitions of differing class

    Note

    Error

    The inner admonition should appear in a different colour to the outer one.

  2. Permit linking admonitions

    Example

    When hovering the title of this admonition a link symbol should appear.

  3. Add warning symbols before deprecated items.

    Deprecated since version 1.2.3: Oh no!

  4. Make versionchanged items more prominent.

    Changed in version 1.2.3: Something changed!

  5. Restyle code-block captions

    Hello World
    $ echo 'hello world'

  6. Address lack of whitespace under lists in admonitions

    Example

    • Darmok

    • Jalad

    Temba, his arms wide.

  7. Improve sidebar scrolling

Extension is automatically loaded for all code diffs when it is added to a project’s Sphinx extensions. No directives required.