# 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.
Raw data
{
"_id": null,
"home_page": "https://karma_sphinx_theme.readthedocs.io",
"name": "karma_sphinx_theme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Stuart George",
"author_email": "stuart@accentdesign.co.uk",
"download_url": "https://files.pythonhosted.org/packages/53/38/25be66e776ee0d088d19a0b3d1abc58020cf8cb88d921e8b72d1c25ae641/karma_sphinx_theme-0.0.8.tar.gz",
"platform": "",
"description": "# Karma Sphinx Theme\n\nA simple responsive theme for sphinx. This theme is in it's early stage of development so only \ncontains limited options.\n\n## Installing\n\n```\npip install karma_sphinx_theme\n```\n\n## Configuration\n\nThe theme's project-wide options are defined in the `karma_sphinx_theme/theme.conf`\nfile, and can be defined in your project's `conf.py` via\n`html_theme_options`. For example:\n\n```\nhtml_theme_options = {\n 'navigation_depth': 2,\n 'includehidden': True,\n 'titles_only': False\n}\n```\n\n## Options\n\n* `navigation_depth` Int. Indicate the max depth of the tree, by default, 2 levels are included.\n* `includehidden` Bool. Specifies if the sidebar includes toctrees marked with the `:hidden:` option\n* `titles_only` Bool. If True, removes headers within a page from the sidebar.",
"bugtrack_url": null,
"license": "",
"summary": "A sphinx theme built with KarmaCSS",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://karma_sphinx_theme.readthedocs.io"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "533825be66e776ee0d088d19a0b3d1abc58020cf8cb88d921e8b72d1c25ae641",
"md5": "877713fed74d1ba0d7ca3d791a2fc724",
"sha256": "5a95f91818b458bd5bdf62690828361a369a222f0721cd0e1eb2ea29056e8c27"
},
"downloads": -1,
"filename": "karma_sphinx_theme-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "877713fed74d1ba0d7ca3d791a2fc724",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 96101,
"upload_time": "2018-06-20T00:03:29",
"upload_time_iso_8601": "2018-06-20T00:03:29.073698Z",
"url": "https://files.pythonhosted.org/packages/53/38/25be66e776ee0d088d19a0b3d1abc58020cf8cb88d921e8b72d1c25ae641/karma_sphinx_theme-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-06-20 00:03:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "karma_sphinx_theme"
}
JSON