Metadata-Version: 2.1
Name: sphinx-nervproject-theme
Version: 1.0.7
Summary: A Sphinx-doc theme based on Vuepress
Home-page: https://procrastinator.nerv-project.eu/nerv-project/communication/sphinx_nervproject_theme
Author: Kujiu
Author-email: kujiu-pypi@kujiu.org
License: EUPL 1.2
Project-URL: Source, https://procrastinator.nerv-project.eu/nerv-project/communication/sphinx_nervproject_theme
Project-URL: Issues, https://procrastinator.nerv-project.eu/nerv-project/communication/sphinx_nervproject_theme/issues
Description: 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
        ~~~~~~~~~~~
        
        First build web assets:
        
        .. code:: bash
        
           cd ui
           npm run build
        
        Sphinx theme has a soft link to built assets...
        Install theme locally with `pip install -e .`.
        
        `docs` folder contains theme's own documentantion.
        
        .. code:: bash
        
           cd docs
           make clean; make html
        
        Website
        ~~~~~~~
        
        To update website:
        
        .. code:: bash
        
           cd ../press_site
           rsync -rvi ../sphinx_vuepress_theme/docs/build/html/ .
           git add --all
        
        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>`_
        
Keywords: sphinx doc theme vue.js
Platform: UNKNOWN
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: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/x-rst
