Sphinx theme for BlueRobotics documentation projects
Project description
A customized toolchain for Blue Robotics documentation projects, built on the Sphinx framework.
For more information on how to use this theme, refer to the documentation.
Features
This theme extends the sphinx-immaterial theme, enhanced with the following features:
Custom branding: Incorporates the Blue Robotics logo and colors for consistent branding across documentation.
Multiversion support: Includes a dropdown menu for switching between different versions of the documentation.
Built-in extensions: Pre-configured extensions tailored for use in all Blue Robotics documentation projects.
Prerequisites
Before getting started, make sure you have the following tools installed:
Git
Python 3.12 or higher
Make
Quickstart
cd docs
make previewRelease a new theme version
To release a new theme version:
Update the version in the pyproject.toml file.
Run poetry build to build the package.
Run poetry publish to publish the package to the Python Package Index.
License
More info coming soon.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_blue_robotics_theme-0.0.3.tar.gz.
File metadata
- Download URL: sphinx_blue_robotics_theme-0.0.3.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.12.0rc1 Darwin/24.0.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8416afa4bb4946002f541ed724b5dfd8e78c96a574463b3ee1157a3bd9a9e3b8
|
|
| MD5 |
aa00b710c645df16b92ce09ed8800d30
|
|
| BLAKE2b-256 |
328ecda6cc8821b2be3152dbd1a847937de37055c90fe7911e4e14dd23acf81b
|
File details
Details for the file sphinx_blue_robotics_theme-0.0.3-py3-none-any.whl.
File metadata
- Download URL: sphinx_blue_robotics_theme-0.0.3-py3-none-any.whl
- Upload date:
- Size: 1.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.5 CPython/3.12.0rc1 Darwin/24.0.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b3d8dafc9f72f656ddeb4925a863262a771f96442e9af8494d03e91c108f5f17
|
|
| MD5 |
4ab4c4d3c0a197c50c0100d4ff54c997
|
|
| BLAKE2b-256 |
45b5f8f37bd7359d8397529892fff906470dac1ba6da8f6dbd713f28f4ccf4e9
|
