https://github.com/bluerobotics/sphinx-blue-robotics-theme
Sphinx theme for Blue Robotics projects
https://github.com/bluerobotics/sphinx-blue-robotics-theme
Last synced: 2 months ago
JSON representation
Sphinx theme for Blue Robotics projects
- Host: GitHub
- URL: https://github.com/bluerobotics/sphinx-blue-robotics-theme
- Owner: bluerobotics
- License: other
- Created: 2024-11-13T09:44:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-10T15:05:30.000Z (about 1 year ago)
- Last Synced: 2025-10-29T04:55:25.967Z (8 months ago)
- Language: HTML
- Homepage: https://docs.bluerobotics.com/sphinx-blue-robotics-theme/
- Size: 7 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==========================
sphinx-blue-robotics-theme
==========================
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
- `Poetry `_
Quickstart
----------
.. code-block:: bash
cd docs
make preview
Release a new theme version
---------------------------
To release a new theme version:
1. Update the version in the ``pyproject.toml`` file.
2. Run ``poetry build`` to build the package.
3. Run ``poetry publish`` to publish the package to the Python Package Index.
License
-------
More info coming soon.