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
File details
Details for the file tensorly-sphinx-theme-0.2.3.tar.gz
.
File metadata
- Download URL: tensorly-sphinx-theme-0.2.3.tar.gz
- Upload date:
- Size: 51.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fdf813059560b269baf15d1deffc4fe07b7dfc9c4e63e71eb29b7d3171cbc66 |
|
MD5 | 0cc7dc97d94a83e0791d3efb340b45be |
|
BLAKE2b-256 | ec7312647e483a31db41e4398e13cc19ad675534cb5b7fdda5b6ab98c3ef9ef3 |
File details
Details for the file tensorly_sphinx_theme-0.2.3-py3-none-any.whl
.
File metadata
- Download URL: tensorly_sphinx_theme-0.2.3-py3-none-any.whl
- Upload date:
- Size: 53.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a58220f3962b82a25dc477983dfac53343d7b6f16d9b02be74ad49e330a8fc42 |
|
MD5 | a2490f718c132106e43a41450dd35c8d |
|
BLAKE2b-256 | 8b4650f122bd2effc30a490c3b690db9f78ae376a2554ec51429c33f97227dc8 |