Sphinx BlueBrain Theme
======================
|build_status| |license| |black| |docs|
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| 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 <https://squidfunk.github.io/mkdocs-material/>`__
MIT License, see `the license <https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE>`__.
`Open Sans font <https://fonts.google.com/specimen/Open+Sans>`__
Apache License Version 2.0, see `the license <https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/src/assets/fonts/open-sans/LICENSE.txt>`__.
`Titillium Web font <https://fonts.google.com/specimen/Titillium+Web>`__
Open Font License Version 1.1, see `the license <https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/src/assets/fonts/titillium-web/OFL.txt>`__.
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 <https://github.com/squidfunk/mkdocs-material>`__ is
licensed under the MIT license and is hosted on GitHub.
You can see examples (and the associated ``rst`` source) in the |sample| 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
.. |build_status| image:: https://travis-ci.com/BlueBrain/sphinx-bluebrain-theme.svg?branch=master
:target: https://travis-ci.com/BlueBrain/sphinx-bluebrain-theme
:alt: Build Status
.. |license| image:: https://img.shields.io/pypi/l/sphinx-bluebrain-theme
:target: https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/LICENSE.txt
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |docs| image:: https://readthedocs.org/projects/sphinx-bluebrain-theme/badge/?version=latest
:target: https://sphinx-bluebrain-theme.readthedocs.io/
:alt: documentation status
.. substitutions
.. |changelog| replace:: changelog_
.. _changelog: CHANGELOG.rst
.. |usage| replace:: `usage guide <usage_>`_
.. _usage: doc/source/usage.rst
.. |sample| replace:: `samples <sample_>`_
.. _sample: doc/source/sample.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/BlueBrain/sphinx-bluebrain-theme",
"name": "sphinx-bluebrain-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Blue Brain Project, EPFL",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/28/d2/f838aebe321ff46b80c223b0686da890f8759132a27d5bda104c63c24a4f/sphinx-bluebrain-theme-0.4.4.tar.gz",
"platform": null,
"description": "Sphinx BlueBrain Theme\n======================\n\n|build_status| |license| |black| |docs|\n\nIntroduction\n------------\n\nSphinx BlueBrain Theme is the standard Blue Brain Project documentation theme.\n\nYou can view the |changelog| to see what has changed recently.\n\nInstallation\n------------\n\nYou can install the theme using `pip`::\n\n pip install sphinx-bluebrain-theme\n\nUsage\n-----\n\nRefer to the |usage| for how to use the theme.\n\nLicense\n-------\n\nThe code for the theme is licensed under the MIT License.\n\nThe name \"Blue Brain Project\" and the EPFL logo are property of their respective\nowners and do not fall under the MIT license.\n\nThe theme incorporates third party components which are listed below, along with their relevant licenses:\n\n`Material for MkDocs theme <https://squidfunk.github.io/mkdocs-material/>`__\n MIT License, see `the license <https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE>`__.\n`Open Sans font <https://fonts.google.com/specimen/Open+Sans>`__\n Apache License Version 2.0, see `the license <https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/src/assets/fonts/open-sans/LICENSE.txt>`__.\n`Titillium Web font <https://fonts.google.com/specimen/Titillium+Web>`__\n Open Font License Version 1.1, see `the license <https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/src/assets/fonts/titillium-web/OFL.txt>`__.\nEPFL logo\n The EPFL logo is copyright EPFL. All rights reserved.\n\nAbout\n-----\n\nSphinx BlueBrain Theme is a Sphinx theme based on the excellent *Material for\nMkDocs* theme by Martin Donath (@squidfunk).\n\nThe `original theme <https://github.com/squidfunk/mkdocs-material>`__ is\nlicensed under the MIT license and is hosted on GitHub.\n\nYou can see examples (and the associated ``rst`` source) in the |sample| page.\n\nSphinx BlueBrain Theme is built through a combination of text replacement rules,\nHTML template overrides, a small amount of additional CSS and Javascript, and\na python module which injects additional required context.\n\nAcknowledgement\n---------------\n\nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nCopyright (c) 2020-2024 Blue Brain Project/EPFL\n\n\n.. |build_status| image:: https://travis-ci.com/BlueBrain/sphinx-bluebrain-theme.svg?branch=master\n :target: https://travis-ci.com/BlueBrain/sphinx-bluebrain-theme\n :alt: Build Status\n\n.. |license| image:: https://img.shields.io/pypi/l/sphinx-bluebrain-theme\n :target: https://github.com/BlueBrain/sphinx-bluebrain-theme/blob/master/LICENSE.txt\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |docs| image:: https://readthedocs.org/projects/sphinx-bluebrain-theme/badge/?version=latest\n :target: https://sphinx-bluebrain-theme.readthedocs.io/\n :alt: documentation status\n\n.. substitutions\n.. |changelog| replace:: changelog_\n.. _changelog: CHANGELOG.rst\n.. |usage| replace:: `usage guide <usage_>`_\n.. _usage: doc/source/usage.rst\n.. |sample| replace:: `samples <sample_>`_\n.. _sample: doc/source/sample.rst\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Blue Brain Project theme for Sphinx",
"version": "0.4.4",
"project_urls": {
"Homepage": "https://github.com/BlueBrain/sphinx-bluebrain-theme",
"Source": "https://github.com/BlueBrain/sphinx-bluebrain-theme",
"Tracker": "https://github.com/BlueBrain/sphinx-bluebrain-theme/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28d2f838aebe321ff46b80c223b0686da890f8759132a27d5bda104c63c24a4f",
"md5": "a2585ed3a846fc92f9e2946c1c1fed83",
"sha256": "a90315207fab68efc4e290b12bbb6af9e92bd7613eedf54f2d6fc821bf543978"
},
"downloads": -1,
"filename": "sphinx-bluebrain-theme-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "a2585ed3a846fc92f9e2946c1c1fed83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1319015,
"upload_time": "2024-02-14T15:15:38",
"upload_time_iso_8601": "2024-02-14T15:15:38.462783Z",
"url": "https://files.pythonhosted.org/packages/28/d2/f838aebe321ff46b80c223b0686da890f8759132a27d5bda104c63c24a4f/sphinx-bluebrain-theme-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 15:15:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "sphinx-bluebrain-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-bluebrain-theme"
}
JSON
