Skip to main content

Blue Brain Project theme for Sphinx

Project description

Build Status license black documentation status

Introduction

Sphinx BlueBrain Theme is the standard Blue Brain Project documentation theme.

You can view the changelog to see what has changed recently.

Installation

You can install the theme using pip:

pip install sphinx-bluebrain-theme

Usage

Refer to the usage guide for how to use the theme.

License

The code for the theme is licensed under the MIT License.

The name “Blue Brain Project” and the EPFL logo are property of their respective owners and do not fall under the MIT license.

The theme incorporates third party components which are listed below, along with their relevant licenses:

Material for MkDocs theme

MIT License, see the license.

Open Sans font

Apache License Version 2.0, see the license.

Titillium Web font

Open Font License Version 1.1, see the license.

EPFL logo

The EPFL logo is copyright EPFL. All rights reserved.

About

Sphinx BlueBrain Theme is a Sphinx theme based on the excellent Material for MkDocs theme by Martin Donath (@squidfunk).

The original theme is licensed under the MIT license and is hosted on GitHub.

You can see examples (and the associated rst source) in the samples page.

Sphinx BlueBrain Theme is built through a combination of text replacement rules, HTML template overrides, a small amount of additional CSS and Javascript, and a python module which injects additional required context.

Acknowledgement

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

Copyright (c) 2020-2024 Blue Brain Project/EPFL

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-bluebrain-theme-0.4.4.tar.gz (1.3 MB view details)

Uploaded Source

File details

Details for the file sphinx-bluebrain-theme-0.4.4.tar.gz.

File metadata

File hashes

Hashes for sphinx-bluebrain-theme-0.4.4.tar.gz
Algorithm Hash digest
SHA256 a90315207fab68efc4e290b12bbb6af9e92bd7613eedf54f2d6fc821bf543978
MD5 a2585ed3a846fc92f9e2946c1c1fed83
BLAKE2b-256 28d2f838aebe321ff46b80c223b0686da890f8759132a27d5bda104c63c24a4f

See more details on using hashes here.

Provenance

Supported by

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