Bulma-based Sphinx theme from the TensorLy project.
Project description
This is the TensorLy theme for Sphinx documentations, based on Bulma.
Installation
After cloning this repository, simply run:
pip install -e .
Usage
To use the theme in your project, add the following to the conf.py file of your sphinx documentation:
html_theme = "tensorly_sphinx_theme"
Configuration
Project logo
The logo of your project will be used in the navigation bar. You can specify the path to it in your conf.py:
html_logo = '_static/image.png'
In rst files
In your documentation itself, you can use :no-toc:, :no-localtoc: and :no-pagination: to remove the side-menu’s table of content (toc), local toc (“on this page”) and pagination buttons, respectively. For instance, if you don’t want file.rst to have a toc, simply add in the file:
:no-toc:
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
Built Distribution
Hashes for tensorly-sphinx-theme-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e833b8355badb3ed406af51814eb5139bc88e2b1ef5ace674c8f96e422febea |
|
MD5 | fa37e3b94bae6df7d163290eb09de587 |
|
BLAKE2b-256 | 1ef4e600e809c1d10831c554d95f8f977b8e10b804362202f0f91b96a7239d41 |
Hashes for tensorly_sphinx_theme-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 507696ff57096ab17755cae3d1c60af09f08479f10c899797842562d7d3ab8de |
|
MD5 | 858f27496258d02b7e11136dcf17bcaf |
|
BLAKE2b-256 | 363a00f0ed6d7c142f8463fff86b4080ff60c95bd40bad7367e1e56eb039e90a |