Skip to main content

A sphinx theme built with KarmaCSS

Project description

# Karma Sphinx Theme

A simple responsive theme for sphinx. This theme is in it's early stage of development so only
contains limited options.

## Installing

pip install karma_sphinx_theme

## Configuration

The theme's project-wide options are defined in the `karma_sphinx_theme/theme.conf`
file, and can be defined in your project's `` via
`html_theme_options`. For example:

html_theme_options = {
'navigation_depth': 2,
'includehidden': True,
'titles_only': False

## Options

* `navigation_depth` Int. Indicate the max depth of the tree, by default, 2 levels are included.
* `includehidden` Bool. Specifies if the sidebar includes toctrees marked with the `:hidden:` option
* `titles_only` Bool. If True, removes headers within a page from the sidebar.

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

karma_sphinx_theme-0.0.7.tar.gz (96.1 kB view hashes)

Uploaded Source

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