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-themeOf 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-kr-theme-0.2.0.tar.gz.
File metadata
- Download URL: sphinx-kr-theme-0.2.0.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 068494c8cace19a9189db092f49202310e8368ca80781cb1b71d977d54c869c0 |
|
| MD5 | 2e4142e1dff08207edc77fa099eef634 |
|
| BLAKE2b-256 | 770cf97c9519b4b5721e601f8ca453ad97e5c37098d52cbf8c65fadeb8c6fb75 |
File details
Details for the file sphinx_kr_theme-0.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_kr_theme-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5395eafb8f6959b2171052a0e5ecd197dcb95c0eb0431b9b47d387ed970400b |
|
| MD5 | 3d11a8b429842a0257f235873cdde773 |
|
| BLAKE2b-256 | eb49888374623b1978699b171090fa7017f74404f5ba0fa09870a0750754a7e3 |
