yummy-sphinx-theme

Yummy Sphinx Theme

https://img.shields.io/pypi/l/yummy_sphinx_theme.svg

https://img.shields.io/pypi/pyversions/yummy_sphinx_theme.svg

https://img.shields.io/github/issues-raw/TagnumElite/yummy_sphinx_theme.svg

https://img.shields.io/travis/TagnumElite/yummy_sphinx_theme/develop.svg

Demo

Installation

There are two ways to install these themes

Via Python Package Interface

Download the package and add sphinx to your requirements.txt file:

pip install yummy_sphinx_theme

In your conf.py file:

html_theme = "yummy_sphinx_theme"

Via git or download

Download the yummy_sphinx_theme folder into your documentation at docs/_themes/ then add the following two lines to your Sphinx conf.py file:

html_theme = "yummy_sphinx_theme"
html_theme_path = ["_themes", ]

Configuration

The theme’s project-wide options are defined in the yummy_sphinx_theme/theme.conf file of this repository, and can be defined in your project’s conf.py via html_theme_options.

For example:

html_theme_options = {
    'home': 'https://github.com/TagnumElite',
    'projects': 'https://github.com/TagnumElite/?tab=repositories',
    'blog': 'https://tagnumelite.elitekast.com',
    'forums': 'https://forums.example.com'
}

If home is not specified in the theme_options it turns into the documentation home. If home is specified then there is a new option called Documentation on the navbar.

Changelog

Yummy

0.0.2:

Add Dedicated Documentation Page
Add Disqus
Add Content To Layout
Made Navbar into Dictionary
Made Navbar background color customisable in theme conf
Use bowser to manage dependencies
Add GitHub, GitLab, BitBucket and Canonical Urls
Disable Octicons and Primer-Markdown
Clean Layout.html
Source Code footer Icon changes to the specified url
Add the missing end html tag

0.0.1:

Turn jekyll theme into sphinx theme
Renamed project from niftools_sphinx_theme to yummy_sphinx_theme

Niftools

0.0.8:

Add Dedicated Documentation Page
Added Bootstrap

0.0.7:

Disolve niftools_sphinx_theme and move it here

Download files

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

Source Distribution

yummy_sphinx_theme-0.0.2.tar.gz (1.3 MB view details)

Uploaded Nov 30, 2017 Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

yummy_sphinx_theme-0.0.2-py2.py3-none-any.whl (1.4 MB view details)

Uploaded Nov 30, 2017 Python 2Python 3

yummy_sphinx_theme-0.0.2-py2.7.egg (1.4 MB view details)

Uploaded Nov 30, 2017 Egg

File details

Details for the file yummy_sphinx_theme-0.0.2.tar.gz.

File metadata

Download URL: yummy_sphinx_theme-0.0.2.tar.gz
Upload date: Nov 30, 2017
Size: 1.3 MB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for yummy_sphinx_theme-0.0.2.tar.gz
Algorithm	Hash digest
SHA256	`fe9c79772d1f9b79bf95a8f2cebf118b64ebd907fbbcee613e7653870029d8af`
MD5	`0c91d642d3c6de8da6a3443c0c6c3be2`
BLAKE2b-256	`6af02c2a7847fef3850bd07cb73756e4654bf52438fb8c1cd41ec2c30aff0d07`

See more details on using hashes here.

File details

Details for the file yummy_sphinx_theme-0.0.2-py2.py3-none-any.whl.

File metadata

Download URL: yummy_sphinx_theme-0.0.2-py2.py3-none-any.whl
Upload date: Nov 30, 2017
Size: 1.4 MB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for yummy_sphinx_theme-0.0.2-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`9dc60b9e02f5af6c2cfd2c46bbdff9346a4224071bc37cac5bd4b098cdd20164`
MD5	`c2aacb1d8d9fa917244108334d9a6b1c`
BLAKE2b-256	`af784dff00d0dd47ff941c2d5b4df64b851a6607222996ca996a3a0f2239830c`

See more details on using hashes here.

File details

Details for the file yummy_sphinx_theme-0.0.2-py2.7.egg.

File metadata

Download URL: yummy_sphinx_theme-0.0.2-py2.7.egg
Upload date: Nov 30, 2017
Size: 1.4 MB
Tags: Egg
Uploaded using Trusted Publishing? No

File hashes

Hashes for yummy_sphinx_theme-0.0.2-py2.7.egg
Algorithm	Hash digest
SHA256	`ccd02187b1dad61cd713857cb562fc255c4366fab686d70b5b2655cf13c92ff5`
MD5	`8bf9ad9feaff33eee706c913853365ff`
BLAKE2b-256	`04165d095f4a75f41afe14b31312a02e08731d9753f2a8a5709a6fdda5cfefa0`