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 `conf.py` 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.8.tar.gz (96.1 kB view details)

Uploaded Source

File details

Details for the file karma_sphinx_theme-0.0.8.tar.gz.

File metadata

File hashes

Hashes for karma_sphinx_theme-0.0.8.tar.gz
Algorithm Hash digest
SHA256 5a95f91818b458bd5bdf62690828361a369a222f0721cd0e1eb2ea29056e8c27
MD5 877713fed74d1ba0d7ca3d791a2fc724
BLAKE2b-256 533825be66e776ee0d088d19a0b3d1abc58020cf8cb88d921e8b72d1c25ae641

See more details on using hashes here.

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