Metadata-Version: 2.1
Name: sphinxawesome-theme
Version: 1.1.0
Summary: A simple theme for a Sphinx documentation
Home-page: https://github.com/kai687/sphinxawesome-theme
License: MIT
Author: Kai Welke
Author-email: 17420240+kai687@users.noreply.github.com
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
   :class: badge
   
.. 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
   :class: badge

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

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:

.. code:: console

   pip install sphinxawesome-theme

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

.. code:: python

   html_theme = "sphinxawesome_theme"

-------------
Configuration
-------------

To show also entries in the navigation menu from `toctree
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=toctree#directive-toctree>`_
directives with the ``:hidden:`` option, add the following setting to the Sphinx
configuration file ``conf.py``.

.. code:: python

   html_theme_options = {"nav_include_hidden": True}

Including ``:hidden:`` in a toctree directive makes Sphinx include the documents, but
not print the list of links to the documents on the current page. This is useful when
navigation links are shown elsewhere, for example in a menu on the left side. The
default is ``nav_include_hidden=False`` in order to be compatible with other themes.

-----------
Limitations
-----------

This theme is designed to be simple. Some features are not (or not yet) available.

- API documentation has not been tested. Some styles might be missing.
- Not all docutils/Sphinx roles have styles. There are a lot of them.
- Some text is only available in English.

.. include-until-here

-------------
Documentation
-------------

Read the documentation and see how the theme looks on the `demo page
<https://sphinxawesome.xyz>`_

