===============
Getting Started
===============

Sphinx Press is a modern responsive theme for python's
`Sphinx docs <http://www.sphinx-doc.org>`_.

This theme is based on `VuePress <https://vuepress.vuejs.org/>`_.
It uses `Vue.js <https://vuejs.org/>`_ &
`Stylus <http://stylus-lang.com/>`_ managed by
`vite <http://vitejs.dev/>`_.



Install
=======


First install the theme:

.. code-block:: console

   $ pip install sphinx_press_theme

Sphinx version compatibility:

========  ===========
Sphinx    Press Theme
========  ===========
4.X        latest
3.X        0.6.1
2.X        0.5.1
========  ===========


Usage
=====

On Sphinx project's ``conf.py``: set the theme name to ``press``.

.. code-block:: python

   html_theme = "press"


See details on :doc:`configuration <configuration>`.


Status
======

**Press** theme is still in **BETA**.

Contributions are welcome.
