=====================
TensorLy Sphinx Theme
=====================
This is the `TensorLy <tensorly.org>`_ theme for `Sphinx <https://www.sphinx-doc.org/en/master/>`_ documentations,
based on `Bulma <https://bulma.io>`_.
Installation
============
After cloning this repository, simply run:
.. code:: bash
pip install -e .
Usage
=====
To use the theme in your project, add the following to the `conf.py` file of your sphinx documentation:
.. code:: python
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`:
.. code:: rst
html_logo = '_static/image.png'
Navigation and main options
---------------------------
You can set most of the parameters in your sphinx configuration file (`conf.py`).
The options are:
* `'google_analytics'` : str, your Google analytics ID, if any.
* `'nav_links'` : tuple list, a list of ('Link display name', 'local.file'), contains the links to the local documentation, in the top navigation bar.
if the link starts with 'http', it will be considered as an external link.
* `'nav_dropdowns'` : same as above but contains multiple links in a dropdown.
**Example:**
.. code:: rst
html_theme_options = {
'google_analytics' : 'YOUR_GOOGLE_ANALYTICS_ID',
'nav_links' : [('Install', 'installation'),
('User Guide', 'user_guide/index'),
('TensorLy', 'https://github.com/tensorly/tensorly'),
('TensorLy-Torch', 'https://github.com/tensorly/torch')],
'nav_dropdowns': [('LinksInDropdown', [('TensorLy', 'http://tensorly.org/dev'),
('TensorLy-Viz', 'http://tensorly.org/viz'),
('TensorLy-Quantum', 'http://tensorly.org/quantum')]
)],
}
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:
.. code::
:no-toc:
Raw data
{
"_id": null,
"home_page": "https://github.com/tensorly/tensorly-sphinx-theme",
"name": "tensorly-sphinx-theme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jean Kossaifi",
"author_email": "jean.kossaifi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/27/a7/a861ea4570d004fa1adb9dce29fdb209e2e85f993a301ea4bb540f037bd2/tensorly-sphinx-theme-0.2.2.tar.gz",
"platform": null,
"description": "=====================\nTensorLy Sphinx Theme\n=====================\n\nThis is the `TensorLy <tensorly.org>`_ theme for `Sphinx <https://www.sphinx-doc.org/en/master/>`_ documentations,\nbased on `Bulma <https://bulma.io>`_.\n\nInstallation\n============\n\nAfter cloning this repository, simply run:\n\n.. code:: bash\n\n pip install -e .\n\n\nUsage \n=====\n\nTo use the theme in your project, add the following to the `conf.py` file of your sphinx documentation:\n\n.. code:: python\n\n html_theme = \"tensorly_sphinx_theme\"\n\n\nConfiguration\n=============\n\nProject logo\n------------\nThe logo of your project will be used in the navigation bar. You can specify the path to it in your `conf.py`:\n\n.. code:: rst\n\n html_logo = '_static/image.png'\n\n\nNavigation and main options\n---------------------------\n\nYou can set most of the parameters in your sphinx configuration file (`conf.py`). \n\nThe options are:\n\n* `'google_analytics'` : str, your Google analytics ID, if any.\n* `'nav_links'` : tuple list, a list of ('Link display name', 'local.file'), contains the links to the local documentation, in the top navigation bar.\n if the link starts with 'http', it will be considered as an external link.\n* `'nav_dropdowns'` : same as above but contains multiple links in a dropdown. \n\n\n**Example:**\n\n.. code:: rst\n\n html_theme_options = {\n 'google_analytics' : 'YOUR_GOOGLE_ANALYTICS_ID',\n 'nav_links' : [('Install', 'installation'), \n ('User Guide', 'user_guide/index'),\n ('TensorLy', 'https://github.com/tensorly/tensorly'),\n ('TensorLy-Torch', 'https://github.com/tensorly/torch')],\n 'nav_dropdowns': [('LinksInDropdown', [('TensorLy', 'http://tensorly.org/dev'),\n ('TensorLy-Viz', 'http://tensorly.org/viz'),\n ('TensorLy-Quantum', 'http://tensorly.org/quantum')]\n )],\n }\n\n\nIn rst files\n------------\n\nIn your documentation itself, you can use ``:no-toc:``, ``:no-localtoc:`` and ``:no-pagination:``\nto remove the side-menu's table of content (toc), local toc (\"on this page\") \nand pagination buttons, respectively.\nFor instance, if you don't want ``file.rst`` to have a toc, simply add in the file:\n\n.. code::\n\n :no-toc:\n",
"bugtrack_url": null,
"license": "Modified BSD",
"summary": "Bulma-based Sphinx theme from the TensorLy project.",
"version": "0.2.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "9ade8cfe799f73dd0dcf669cd757a0bf",
"sha256": "00eaff966aac802ae426d00d8ddcf299d0b9ff30e878ae12ffa182ef281cce7a"
},
"downloads": -1,
"filename": "tensorly_sphinx_theme-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ade8cfe799f73dd0dcf669cd757a0bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 53191,
"upload_time": "2023-01-01T16:34:41",
"upload_time_iso_8601": "2023-01-01T16:34:41.129579Z",
"url": "https://files.pythonhosted.org/packages/38/a3/c069b682efc7db407ff7f2c1850986e9de563044a9b1d116d9727d9f80ca/tensorly_sphinx_theme-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "7efc74c2837f2bce282e6130ca3d39da",
"sha256": "ad13f2066fa6eca055e4e12aa777fd3457a7e930547d0b15a165735df46d8723"
},
"downloads": -1,
"filename": "tensorly-sphinx-theme-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "7efc74c2837f2bce282e6130ca3d39da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 51799,
"upload_time": "2023-01-01T16:34:42",
"upload_time_iso_8601": "2023-01-01T16:34:42.711971Z",
"url": "https://files.pythonhosted.org/packages/27/a7/a861ea4570d004fa1adb9dce29fdb209e2e85f993a301ea4bb540f037bd2/tensorly-sphinx-theme-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-01 16:34:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "tensorly",
"github_project": "tensorly-sphinx-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": []
}
],
"lcname": "tensorly-sphinx-theme"
}
JSON
