Skip to main content

A simple theme for a Sphinx documentation

Project description

MIT license PyPI package version number Netlify Status

This is a simple but awesome theme for the Sphinx documentation generator.

Installation

Install the theme as a Python package:

pip install sphinxawesome-theme

Usage

To use the theme, set html_theme in the Sphinx configuration file conf.py:

html_theme = "sphinxawesome_theme"

To include all entries in the navigation menu, add the following setting to the Sphinx configuration file conf.py.

html_theme_options = {"nav_include_hidden": True}

If you set the option :hidden: to a toctree directive, the content will be included, but the list of links to the documents will not be written on the page itself. This can be useful when navigation links are shown elsewhere.

The Sphinx awesome theme shows a navigation menu on the left side of all pages, so having the links shown in the content area is not necessary. In order allow an easy transition from other Sphinx themes, the default is nav_include_hidden = False.

To make best use of this theme, include the :hidden: option to all ..toctree directives and set nav_include_hidden = True.

Demo

See how the theme looks on the demo page.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxawesome-theme-1.3.1.tar.gz (355.8 kB view hashes)

Uploaded Source

Built Distribution

sphinxawesome_theme-1.3.1-py3-none-any.whl (361.1 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