krTheme Sphinx Style

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.

Metadata

Release files for sphinx-kr-theme 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-kr-theme 0.2.1
File	Size	Uploaded	Provenance
sphinx-kr-theme-0.2.1.tar.gz	9.7 kB	Feb 1, 2015	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-kr-theme 0.2.1
File	Interpreter	ABI	Platform	Reset
sphinx_kr_theme-0.2.1-py2.py3-none-any.whl 12.6 kB Feb 1, 2015 Without provenance	Python 2, Python 3	none	any	Details

Total release size: 22.3 kB

Release files / sphinx-kr-theme-0.2.1.tar.gz

Download URL	sphinx-kr-theme-0.2.1.tar.gz
Size	9.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`4241d0ad37f46ad3db954a3d9cb557d697b63eadc6fc38d856117996d12a4e15`
BLAKE2b-256 checksum How to use checksums	`c6ebaf442b97fb8dc2c2cdb3ca48b7ff93e638e9d7d795dbb3c2250eb6ff7b44`
Upload date	Feb 1, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / sphinx_kr_theme-0.2.1-py2.py3-none-any.whl

Download URL	sphinx_kr_theme-0.2.1-py2.py3-none-any.whl
Size	12.6 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`40b8fcc0d66ccb82374ddefcda5e0012ba9f6cc46d3cf4f142a034cce8922b5f`
BLAKE2b-256 checksum How to use checksums	`b6689e80368ef051c0a41a441f7ca86d703dea48647f1a15e2fd0f34e2bde4c1`
Upload date	Feb 1, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for sphinx-kr-theme 0.2.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.