A clean and modern Sphinx theme.
See Read the docs.
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.
We make your autodoc code snippets nice and legible:
This even works for C and C++ files via breathe.
We have a gorgeous dark mode 🥷:
And for users with OLED displays, we have the 'darkest' mode - where the backgrounds are pure black 🧛♂️:
In the root of the project:
npm install -g sass
Then:
./scripts/build-styles.sh
Here are some awesome projects using our theme. We welcome PRs to extend the list:
FAQs
A modern Sphinx theme.
We found that piccolo-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.