1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
===============
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.
|
