A sphinx theme created to mimick Yummy-Jekyll
Project description
.. _demo: http://tagnumelite.elitekast.com/yummy_sphinx_theme
*********************
Yummy Sphinx Theme
*********************
.. image:: https://img.shields.io/pypi/v/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/github/release/TagnumElite/yummy_sphinx_theme/all.svg
:target: https://github.com/TagnumElite/yummy_sphinx_theme
.. image:: https://img.shields.io/pypi/l/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/pypi/pyversions/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/github/issues-raw/TagnumElite/yummy_sphinx_theme.svg
:target: https://github.com/TagnumElite/yummy_sphinx_theme
.. image:: https://img.shields.io/travis/TagnumElite/yummy_sphinx_theme/develop.svg
:target: https://travis-ci.org/niftools/TagnumElite/yummy_sphinx_theme
.. contents::
Demo_
=====
Installation
============
There are two ways to install this theme
Via Python Package Interface
----------------------------
Download the package and add ``sphinx`` to your ``requirements.txt`` file:
.. code:: bash
pip install yummy_sphinx_theme
In your ``conf.py`` file:
.. code:: python
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 settings to your Sphinx
``conf.py`` file:
.. code:: python
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:
.. code:: python
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.
.. include:: CHANGELOG.rst
*********************
Yummy Sphinx Theme
*********************
.. image:: https://img.shields.io/pypi/v/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/github/release/TagnumElite/yummy_sphinx_theme/all.svg
:target: https://github.com/TagnumElite/yummy_sphinx_theme
.. image:: https://img.shields.io/pypi/l/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/pypi/pyversions/yummy_sphinx_theme.svg
:target: https://pypi.org/project/yummy_sphinx_theme/
.. image:: https://img.shields.io/github/issues-raw/TagnumElite/yummy_sphinx_theme.svg
:target: https://github.com/TagnumElite/yummy_sphinx_theme
.. image:: https://img.shields.io/travis/TagnumElite/yummy_sphinx_theme/develop.svg
:target: https://travis-ci.org/niftools/TagnumElite/yummy_sphinx_theme
.. contents::
Demo_
=====
Installation
============
There are two ways to install this theme
Via Python Package Interface
----------------------------
Download the package and add ``sphinx`` to your ``requirements.txt`` file:
.. code:: bash
pip install yummy_sphinx_theme
In your ``conf.py`` file:
.. code:: python
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 settings to your Sphinx
``conf.py`` file:
.. code:: python
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:
.. code:: python
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.
.. include:: CHANGELOG.rst
Project details
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
yummy_sphinx_theme-0.0.1.tar.gz
(350.8 kB
view hashes)
Built Distribution
Close
Hashes for yummy_sphinx_theme-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d301fce3f2cf0e0cdbb27e2dfd420726a0955562c2f6128c9bb17bab02b393f |
|
MD5 | 077cd9b31ba337c0dc2e7fdea85547d6 |
|
BLAKE2b-256 | 0fb0d83d82794383816a62d1fba24ff3f4006a019e615e2489af1161d3e9d4d0 |