https://github.com/piccolo-orm/piccolo_theme

A clean and modern Sphinx theme.
https://github.com/piccolo-orm/piccolo_theme

documentation-theme hacktoberfest piccolo sphinx sphinx-theme theme

Last synced: 2 days ago
JSON representation

A clean and modern Sphinx theme.

• Host: GitHub
• URL: https://github.com/piccolo-orm/piccolo_theme
• Owner: piccolo-orm
• License: mit
• Created: 2022-02-08T22:32:29.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-25T14:48:42.000Z (4 months ago)
• Last Synced: 2024-12-08T12:22:02.037Z (25 days ago)
• Topics: documentation-theme, hacktoberfest, piccolo, sphinx, sphinx-theme, theme
• Language: SCSS
• Homepage: https://piccolo-theme.readthedocs.io/en/latest/
• Size: 3.68 MB
• Stars: 94
• Watchers: 5
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Piccolo Theme

[![Documentation Status](https://readthedocs.org/projects/piccolo-theme/badge/?version=latest)](https://piccolo-theme.readthedocs.io/en/latest/?badge=latest)

[![PyPI](https://img.shields.io/pypi/v/piccolo-theme?color=%2334D058&label=pypi)](https://pypi.org/project/piccolo-theme/)

A clean and modern Sphinx theme.

![Screenshot](https://raw.githubusercontent.com/piccolo-orm/piccolo_theme/master/docs/screenshots/docs.png)

## Docs

See [Read the docs](https://piccolo-theme.readthedocs.io/en/latest/).

## 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](https://raw.githubusercontent.com/piccolo-orm/piccolo_theme/master/docs/screenshots/api_docs.png)

This even works for C and C++ files via [breathe](https://breathe.readthedocs.io/en/latest/).

## Dark mode, and darkest mode!

We have a gorgeous dark mode 🥷:

![Screenshot](https://raw.githubusercontent.com/piccolo-orm/piccolo_theme/master/docs/screenshots/dark_mode.png)

And for users with OLED displays, we have the 'darkest' mode - where the

backgrounds are pure black 🧛‍♂️:

![Screenshot](https://raw.githubusercontent.com/piccolo-orm/piccolo_theme/master/docs/screenshots/darkest_mode.png)

## 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:

* [Cyclone DDS Python: Python binding for Eclipse Cyclone DDS](https://cyclonedds.io/docs/cyclonedds-python/latest/)

* [bitstring: A Python module to help make the creation and analysis of all types of bit-level binary data as simple and efficient as possible](https://bitstring.readthedocs.io/en/stable/#)

* [Lance: Modern columnar data format for ML](https://lancedb.github.io/lance/)