0.15.0

What's Changed

• Add/tests by @mikebarr24 in #40
• update requirements by @dantownsend in #45
• Fix html errors by @mblaschke in #46
• change colour used for emphasis in code blocks by @dantownsend in #49

New Contributors

• @mikebarr24 made their first contribution in #40
• @mblaschke made their first contribution in #46

Full Changelog: 0.14.0...0.15.0

0.14.0

When switching to dark mode, we automatically apply our own custom dark mode styles to code blocks.

This gives a great experience out of the box. However, if someone uses their own Pygments theme, they might want to use that theme in both light mode, and dark mode. They can now do so, using the dark_mode_code_blocks option.

# conf.py

html_theme_options = {
    "dark_mode_code_blocks": False
}

0.13.0

A logo can now be used in the nav bar, instead of text.

# conf.py

# Relative to conf.py:
html_logo = './path/to/logo.png'

# Or an absolute URL:
html_logo = 'https://awesome.com/static/logo.png'

Thanks to @are-scenic for adding this.

0.12.0

You can now specify the source code URL, and it will show in the nav bar.

Just do the following:

# conf.py

html_theme_options = {
    "source_url": 'https://github.com/piccolo-orm/piccolo_theme/'
}

The icon is inferred automatically based on the URL (in the above example, we show the GitHub logo). You can explicitly set the icon if you prefer:

# conf.py

html_theme_options = {
    "source_url": 'https://self-hosted.foo.com/',
    "source_icon": "gitlab"
}

0.11.1

Minor style fix on search page.

0.11.0

Fixed some styles in Sphinx v5.

0.10.2

Drop Python 3.7 specific syntax.

0.10.1

Fix typo in setup.py.

0.10.0

Added support for Python 3.6, as many Ubuntu systems will still be using that version, and Sphinx still supports it. Thanks to @oncilla for reporting this issue.

0.9.0

Improved the appearance of autodoc output for C files (when using breathe). Courtesy @thijsmie.