Piccolo Theme

A clean and modern Sphinx theme.

Screenshot

Docs

Typography

Roboto is used for the body copy, and Roboto Mono for code snippets. As these
fonts belong to the same family, they look nice together. Both of them are
also highly legible on small screens.

We use bold, easy to read headers.

Note - this isn't a Material Design theme. The aim is to create a nice
theme, with our own aesthetic preferences, rather than implementing Google's
Material Design spec.

Code docs

We make your autodoc code snippets nice and legible:

Screenshot

This even works for C and C++ files via breathe.

Dark mode, and darkest mode!

We have a gorgeous dark mode 🥷:

Screenshot

And for users with OLED displays, we have the 'darkest' mode - where the
backgrounds are pure black 🧛‍♂️:

Screenshot

Other design features

Optimised for mobile and web.
A header bar gives the design a splash of colour.
Simple but elegant design.

Contributing

Building styles

In the root of the project:

npm install -g sass

Then:

./scripts/build-styles.sh

Used by

Here are some awesome projects using our theme. We welcome PRs to extend the list:

Package profile

piccolo-theme

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description