.. _`docs.pyrmin.dev`: https://docs.pyrmin.dev/
.. _pyrmin.dev: https://pyrmin.dev
.. _sphinx: http://www.sphinx-doc.org
.. _hidden: http://sphinx-doc.org/markup/toctree.html

*************************
PyRmin Sphinx Theme 0.0.8
*************************

.. contents:: 

View a working demo over on `docs.pyrmin.dev`_.

This is a mobile-friendly sphinx_ theme I made for pyrmin.dev_.
It's currently in development and includes some readthedocs.org variable checks that can be ignored
if you're just trying to use it on your project outside of that site.

Installation
============

Via package
-----------

Download the package or add it to your ``requirements.txt`` file:

.. code:: bash

    $ pip install https://gitlab.pyrmin.dev/PyRmin/sphinx_pyrmin_theme.git

In your ``conf.py`` file:

.. code:: python

    import sphinx_pyrmin_theme

    html_theme = "sphinx_pyrmin_theme"

    html_theme_path = [sphinx_pyrmin_theme.get_html_theme_path()]

Via git or download
-------------------

Symlink or subtree the ``sphinx_pyrmin_theme/sphinx_pyrmin_theme`` repository into your documentation at
``docs/_themes/sphinx_pyrmin_theme`` then add the following two settings to your Sphinx
conf.py file:

.. code:: python

    html_theme = "sphinx_pyrmin_theme"
    html_theme_path = ["_themes", ]