Skip to main content

The third-part package of kennethreitz/kr-sphinx-themes.

Project description

This is the third-part package of Kenneth Reitz’s krTheme. You will not have to copy the theme files into VCS or register it as submodule anymore.

Installation

pip install sphinx-kr-theme

Of course the general usage is putting that into your docs/requirements.txt then it will be found and installed by the build system such as ReadTheDocs.

Usage

In your conf.py:

import sphinx_kr_theme

html_theme = 'kr'  # or 'kr_basic'
html_theme_path = [sphinx_kr_theme.get_html_theme_path()]

In Sphinx >= 1.2, you only need to set the theme name:

html_theme = 'kr_basic'

Releases

0.2.0

Added new options to the kr_basic theme.

Now you can custom the URL and size of the “Fork me on GitHub” ribbon image.

html_theme_options = {
    'github_fork': 'tonyseek/sphinx-kr-theme',
    'github_fork_ribbon': 'http://aral.github.com/fork-me-on-github-retina-ribbons/right-graphite@2x.png',
    'github_fork_ribbon_width': '149px',
    'github_fork_ribbon_height': '149px',
}

The size of index logo is customizable too.

html_theme_options = {
    'index_logo': 'logo@2x.png',
    'index_logo_width': '180px',
    'index_logo_height': '50px',
}

Those options is useful to include Retina-friendly images in your documents.

0.1.0

Included the original repository (Kenneth Reitz’s repository) with git-subtree and uploaded it to PyPI.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx_kr_theme-0.2.1-py2.py3-none-any.whl (12.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Feb 1, 2015
sphinx-kr-theme-0.2.1.tar.gz (9.7 kB) Copy SHA256 hash SHA256 Source None Feb 1, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page