Sphinx Seeta Theme

This sphinx theme extends the customization of navigation and side bar for the project with complex code structures, e.g., the deep learning framework.

Installation

Install from PyPI:

pip install sphinx-seeta-theme

Or, clone this repository to local disk and install:

cd sphinx_seeta_theme && pip instsall .

You can also install from the remote repository:

pip install git+ssh://git@github.com/seetaresearch/sphinx_seeta_theme.git

Configuration

Theme options

For example:

html_theme_options = {
    'navbar_links': {
        'Install': '/install/index.html'
        'API': [
            ('master', '/api/master/index.html'),
            ('v1.0.0', '/api/v1.0.0/index.html'),
        ],
        'Github': 'https://github.com/seetaresearch/sphinx_seeta_theme',
    },
    'navbar_logo_link': '/index.html',
    'sidebar_title': 'v1.0.0',
    'sidebar_title_link': '/versions/index.html',
    'breadcrumb_links': [
        ('Project', '/index.html'),
        ('API', '/versions/index.html'),
        ('v1.0.0', '/api/v1.0.0/index.html'),
    ],
}

License

BSD 2-Clause license

Metadata

Release files for sphinx-seeta-theme 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-seeta-theme 0.1.1
File	Interpreter	ABI	Platform	Reset
sphinx_seeta_theme-0.1.1-py3-none-any.whl 3.0 MB Sep 18, 2022	Python 3	none	any	Details

Release files / sphinx_seeta_theme-0.1.1-py3-none-any.whl

Download URL	sphinx_seeta_theme-0.1.1-py3-none-any.whl
Size	3.0 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`84735144d51232924a9923763e637c79e568ce8a848e52b6388fcf411ac6c2f8`
BLAKE2b-256 checksum How to use checksums	`9cf6abc9cac54baf06862dc094ab63e44fd28bd82fb668449477df95af56a4dc`
Upload date	Sep 18, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.12`