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.2.tar.gz (615.0 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.2-py3-none-any.whl (627.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_blue_robotics_theme-0.0.2.tar.gz
  • Upload date:
  • Size: 615.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.0rc1 Darwin/24.0.0

File hashes

Hashes for sphinx_blue_robotics_theme-0.0.2.tar.gz
Algorithm Hash digest
SHA256 af48e007918fdcfbd70380f8963c6412047c90d4aa2b64abe4aae183081a254d
MD5 0b98cef025ad7e063a8e31ceafaa83c3
BLAKE2b-256 f43c424b139a5a3ccb2445bb95f7a99e12d532e1988bc96f4a2fc2688638321d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_blue_robotics_theme-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a233f66d5a858a97618892cecbad07c9c14cb6778b5ade479b7c0f71aad0532b
MD5 934d2da911246a886dc33e7ac2f24927
BLAKE2b-256 858ad62d7b5b0bc5867f5a4ced0369fe4db4dc2c35e0de9884b0894bcf72002b

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