Skip to main content

Sphinx theme for BlueRobotics documentation projects

Project description

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

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

cd docs
make preview

License

More info coming soon.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_blue_robotics_theme-0.0.1.tar.gz (613.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_blue_robotics_theme-0.0.1-py3-none-any.whl (631.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_blue_robotics_theme-0.0.1.tar.gz.

File metadata

  • Download URL: sphinx_blue_robotics_theme-0.0.1.tar.gz
  • Upload date:
  • Size: 613.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.9 Darwin/24.0.0

File hashes

Hashes for sphinx_blue_robotics_theme-0.0.1.tar.gz
Algorithm Hash digest
SHA256 7f5a0e84cfdf41fb588ba56b9e94ee5a983389d062a5d0bc61a1fdff652487da
MD5 1d4a03e27de49398bbbc3b19117fa485
BLAKE2b-256 ff6d1119b7d406f81ad3257dd48cd41b1ebf56454fb11be8a4138c6f204a141d

See more details on using hashes here.

File details

Details for the file sphinx_blue_robotics_theme-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_blue_robotics_theme-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc7148fceb7babd0099936b9ed1b899d536710a6c50e9054bed2e3e1cd3bd1c1
MD5 26d892f9da7f1fc29e1249738e9e0796
BLAKE2b-256 ae408b0ce9b50b0aff295395d85af80e67ff536c4ca9325ef105c30d130f481e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page