Metadata-Version: 2.1
Name: sphinx_nervproject_theme
Version: 3.0.1
Summary: A Sphinx-doc theme based on     Vuepress
Keywords: sphinx,doc,theme
Author: kujiu, ptitgnu
Author-email: Nerv Project ASBL <contact@nerv-project.eu>
Maintainer: kujiu, ptitgnu
Maintainer-email: Nerv Project ASBL <contact@nerv-project.eu>
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: Sphinx>=7.0.0
Requires-Dist: reportlab
Requires-Dist: sphinx-fasvg
Requires-Dist: ablog>=0.11
Requires-Dist: Sphinx ; extra == "setup"
Requires-Dist: pytest-runner ; extra == "setup"
Requires-Dist: flake8 ; extra == "setup"
Requires-Dist: pylint ; extra == "setup"
Requires-Dist: babel ; extra == "setup"
Requires-Dist: flit ; extra == "setup"
Requires-Dist: pytest ; extra == "tests"
Requires-Dist: flake8 ; extra == "tests"
Requires-Dist: pylint ; extra == "tests"
Requires-Dist: pytest-cov ; extra == "tests"
Project-URL: changelog, https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme/raw/branch/main/CHANGES.rst
Project-URL: editor, https://www.nerv-project.eu
Project-URL: homepage, https://www.nerv-project.eu
Project-URL: issues, https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme/issues
Project-URL: repository, https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme
Provides-Extra: setup
Provides-Extra: tests

Sphinx NervProject Theme
========================

A modern responsive theme for python's `Sphinx <http://www.sphinx-doc.org>`_ documentation generator based on
sphinx_press_theme and ablog.

This theme is based on `VuePress <https://vuepress.vuejs.org/>`_.
It uses `Vue.js <https://vuejs.org/>`_ and LessCSS managed by
`webpack <https://webpack.js.org>`_ through `vue-cli <https://cli.vuejs.org/>`_.


Usage
~~~~~

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

.. code:: python

   html_theme = "nervproject"

See details on `Sphinx theming docs <http://www.sphinx-doc.org/en/master/theming.html#using-a-theme>`_.

Development
~~~~~~~~~~~

To rebuild web assets:

.. code:: bash

   npm run build

Install theme locally with `pip install -e .`.

`docs` folder contains theme's own documentantion.

.. code:: bash

   cd docs
   make clean; make html

Compatibility
~~~~~~~~~~~~~

This theme needs CSS vars enabled in the browser, so
it doesn't work on IE. Four color variations are
available :

- light low contrast (default) ;
- light high contrast ;
- dark low contrast ;
- dark high contrast.

The good one is used based on prefers-contrast and
prefers-color-scheme media queries. This is automatically
done by a compatible browser. If not, the default theme
is used. Some browsers need manual configuration like
Chromium on Linux (a flag to enable for all websites).

Example
~~~~~~~

See the `Nerv Project's web site <https://www.nerv-project.eu>`_

