Metadata-Version: 2.1
Name: sphinxawesome-theme
Version: 1.5.0
Summary: A simple theme for a Sphinx documentation
Home-page: https://github.com/kai687/sphinxawesome-theme
License: MIT
Author: Kai Welke
Author-email: kai687@pm.me
Requires-Python: >=3.6,<4.0
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: sphinx (>3)
Project-URL: Repository, https://github.com/kai687/sphinxawesome-theme
Description-Content-Type: text/x-rst

====================
Sphinx awesome theme
====================
   
.. image:: https://img.shields.io/pypi/l/sphinxawesome-theme?color=blue&style=for-the-badge
   :target: https://opensource.org/licenses/MIT
   :alt: MIT license
   
.. image:: https://img.shields.io/pypi/v/sphinxawesome-theme?style=for-the-badge
   :target: https://pypi.org/project/sphinxawesome-theme
   :alt: PyPI package version number

.. image:: https://img.shields.io/netlify/e6d20a5c-b49e-4ebc-80f6-59fde8f24e22?style=for-the-badge
   :target: https://sphinxawesome.xyz
   :alt: Netlify Status

This is a simple but awesome theme for the `Sphinx
<http://www.sphinx-doc.org/en/master/>`_ documentation generator.


------------
Installation
------------

Install the theme as a Python package:

.. install-start

.. code:: console

   pip install sphinxawesome-theme

.. install-end

Read the full `installation instructions
<https://sphinxawesome.xyz/docs/install.html#how-to-install-the-theme>`_ for more
information.

-----
Usage
-----

.. use-start

To use the theme, set ``html_theme`` in the Sphinx configuration file
``conf.py``:

.. code:: python

   html_theme = "sphinxawesome_theme"

.. use-end

Read the full `usage guide
<https://sphinxawesome.xyz/docs/use.html#how-to-use-the-theme>`_ for more information.

----
Demo
----

See how the theme looks on the `demo page <https://sphinxawesome.xyz>`_.

