Metadata-Version: 1.1
Name: yummy-sphinx-theme
Version: 0.0.2
Summary: A sphinx theme created to mimick Yummy-Jekyll
Home-page: https://github.com/TagnumElite/yummy_sphinx_theme
Author: Tagan Hoyle
Author-email: tagnum.elite@gmail.com
License: MIT
Description: 
        ==================
        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 <http://tagnumelite.elitekast.com/yummy_sphinx_theme>`_
        =============================================================
        
        Installation
        ============
        There are two ways to install these themes
        
        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 lines 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.
        
        =========
        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
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
