Skip to main content

This theme is based on sphinx-bootstrap by Scotch Media and modified for documentation of Kotti and Kotti add-ons.

How does it look?

Visit the Kotti Documentation to see the theme in action.

How to use

Install from PyPI:

pip install kotti_docs_theme

Adjust the settings in your Sphinx conf.py file:

import kotti_docs_theme

html_theme_path = [kotti_docs_theme.get_theme_dir()]
html_theme = 'kotti_docs_theme'
html_theme_options = {
    'github_user': 'Pylons',
    'github_repo': 'Kotti',
    'twitter_username': 'KottiCMS',
    'home_url': 'http://kotti.pylonsproject.org/',
    'mailing_list_url': 'http://groups.google.com/group/kotti',
    'irc_channel_url': 'irc://irc.freenode.net/#kotti',
}

Add a rtd.txt file containing the requirements for building the docs on Read The Docs:

Sphinx
kotti_docs_theme
repoze.sphinx.autointerface
repoze.lru

Change History

0.2

  • Make all html_theme_options keys optional to make the theme usable for docs outside the Kotti universe.

0.1.1

  • Make definitions of classes, functions, methods and attributes larger.

0.1

  • Initial release.

Download files

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

Source Distribution

kotti_docs_theme-0.2.tar.gz (155.8 kB view details)

Uploaded Source

File details

Details for the file kotti_docs_theme-0.2.tar.gz.

File metadata

  • Download URL: kotti_docs_theme-0.2.tar.gz
  • Upload date:
  • Size: 155.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for kotti_docs_theme-0.2.tar.gz
Algorithm Hash digest
SHA256 e7780eca1f32feb017ee6ceed2dc54765c9ec276f2f43738cefc063c2d173af3
MD5 01fe6f0c901f51ac6f02ab016e1ee6aa
BLAKE2b-256 03d85d36d63f8a02a1607c616d59d6ae60c4de2a810099990764bdd0d4528825

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2 This release

1 file

0.1.1

1 file

0.1

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page