Blue Brain Project theme for Sphinx
Project description
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-2022 Blue Brain Project/EPFL
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinx-bluebrain-theme-0.4.2.tar.gz.
File metadata
- Download URL: sphinx-bluebrain-theme-0.4.2.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 81a16d0bf0c1d7a31e728d6f57612685e1b9d04c58369827ed77c650ed2526f0 |
|
| MD5 | 6c8eb90a5dd66597ad46150c5f72c53c |
|
| BLAKE2b-256 | b67244fc9c34226c3bdfe7a08619ff744177c8283678d45ba347a436e8b02884 |
