Metadata-Version: 1.1
Name: niftools-sphinx-theme
Version: 0.3.3
Summary: A sphinx theme created to support niftools documentation
Home-page: https://github.com/TagnumElite/niftools_sphinx_theme
Author: TagnumElite
Author-email: tagnumelite@elitekast.com
License: GPLv3
Description: *********************
        NifTools Sphinx Theme
        *********************
        
        .. image:: https://img.shields.io/pypi/v/niftools_sphinx_theme.svg
           :target: https://pypi.python.org/pypi/niftools_sphinx_theme
           :alt: PyPi Version
        .. image:: https://img.shields.io/travis/com/TagnumElite/niftools_sphinx_theme/develop
           :target: https://travis-ci.com/TagnumElite/niftools_sphinx_theme
           :alt: Build Status
        .. image:: https://img.shields.io/pypi/l/niftools_sphinx_theme.svg
           :target: https://pypi.python.org/pypi/niftools_sphinx_theme/
           :alt: License
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/black
           :alt: Code Style: Black
        
        NifTools_ Sphinx_ theme was created to mimic the NifTools_ website,
        which is running a `modified version <https://github.com/niftools/niftools.github.io>`_ of Yummy-Jekyl_.
        
        This theme is still in planning/development stage!
        Please wait until ver `1.0.0` before using this theme!
        
        
        Features
        ========
        
        Supports these extensions:
        
        - autodoc_
        - viewcode_
        
        Templates
        ^^^^^^^^^
        
        `See More <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_additional_pages>`_
        
        - About Page
        - Blog Page
        - Projects Page
        
        Installation
        ============
        
        This theme can be found on PyPi_ and can be installed through pip
        
        .. code:: console
        
            pip install --upgrade niftools_sphinx_theme
        
        Inside your sphinx ``conf.py`` file you must put this inside
        
        .. code:: python
        
            import niftools_sphinx_theme
        
            extensions = [
                "niftools_sphinx_theme",
                ...
            ]
        
            html_theme = "niftools_sphinx_theme"
        
        Customization
        =============
        
        This theme was created with customization is mind.
        
        Development
        ===========
        
        I include the built files so all you have to do is run sphinx,
        but if you wish to work on this project we use webpack_ to compile
        and copy all CSS_, JavaScript_ and fonts to the static folder.
        
        
        .. _PyPi: https://pypi.python.org/pypi/niftools_sphinx_theme
        .. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
        .. _viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
        .. _Sphinx: http://www.sphinx-doc.org
        .. _NifTools: https://niftools.org
        .. _Yummy-Jekyl: https://github.com/DONGChuan/Yummy-Jekyll/
        .. _CSS: https://developer.mozilla.org/en-US/docs/Web/CSS
        .. _JavaScript: https://developer.mozilla.org/en-US/docs/Web/JavaScript
        .. _webpack: https://webpack.js.org/
        
        
Keywords: sphinx,theme,niftools
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
