Skip to main content

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

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

tensorly-sphinx-theme-0.1.0.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

tensorly_sphinx_theme-0.1.0-py3-none-any.whl (2.8 kB view hashes)

Uploaded Python 3

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