Sphinx theme based on sphinx_press_theme.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Kujiu dc2f6d440c
Add rel=me
2 months ago
demo Refactoring CSS/JS 2 years ago
docs Add rel=me 2 months ago
sphinx_nervproject_theme Add rel=me 2 months ago
ui Add: Padding on left of sidebar 1 year ago
.gitignore Refactoring CSS/JS 2 years ago
AUTHORS Initial release 2 years ago
CHANGES Add rel=me 2 months ago
LICENCE_FOR_FONTAWESOME.txt Refactoring CSS/JS 2 years ago
LICENSE Initial release 2 years ago
LICENSE-de Initial release 2 years ago
LICENSE-fr Initial release 2 years ago
LICENSE-nl Initial release 2 years ago
README-Luciole.txt Fix a lot of ePub errors 2 years ago
README.rst Refactoring CSS/JS 2 years ago
babel.cfg Initial release 2 years ago
package-lock.json Fix a lot of ePub errors 2 years ago
package.json Add rel=me 2 months ago
requirements.txt Update requirements 2 years ago
setup.cfg Add rel=me 2 months ago
setup.py Add rel=me 2 months ago

README.rst

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

Sphinx NervProject Theme

A modern responsive theme for python's Sphinx documentation generator based on sphinx_press_theme and ablog.

This theme is based on VuePress. It uses Vue.js and LessCSS managed by webpack through vue-cli.

Usage

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

html_theme = "nervproject"

See details on Sphinx theming docs.

Development

To rebuild web assets:

npm run build

Install theme locally with pip install -e ..

docs folder contains theme's own documentantion.

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

</html>