Metadata-Version: 2.1
Name: sphinx-blue-robotics-theme
Version: 0.0.2
Summary: Sphinx theme for BlueRobotics documentation projects
Author: TechDocs Studio
Author-email: info@techdocs.studio
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: cpp
Provides-Extra: extras
Provides-Extra: lua
Provides-Extra: python
Requires-Dist: breathe (>=4.35.0) ; extra == "cpp"
Requires-Dist: exhale (>=0.3.7) ; extra == "cpp"
Requires-Dist: myst-parser (>=4.0.0,<5.0.0)
Requires-Dist: sphinx-autodoc2 (>=0.5.0) ; extra == "python"
Requires-Dist: sphinx-design (>=0.6.1,<0.7.0) ; extra == "extras"
Requires-Dist: sphinx-immaterial (>=0.12.4,<0.13.0)
Requires-Dist: sphinx-lua (>=1.1.5) ; extra == "lua"
Description-Content-Type: text/x-rst

==========================
sphinx-blue-robotics-theme
==========================

A customized toolchain for Blue Robotics documentation projects, built on the Sphinx framework.

.. warning::

   **This project is currently under development. Features and functionality may change without notice.**

Features
--------

This theme extends the `sphinx-immaterial <https://jbms.github.io/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 <https://python-poetry.org/>`_

Quickstart
----------

.. code-block:: bash

   cd docs
   make preview

License
-------

More info coming soon.

