nerv-project
/
sphinx_nervproject_theme
8
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Sphinx theme based on sphinx_press_theme.
7 Commits 1 Branch 1 Tag 4.5 MiB
Less 69.5%
HTML 21.3%
Python 4.6%
CSS 4.1%
JavaScript 0.5%
Go to file
Kujiu 3658095fd4
Update version 		2020-05-27 15:54:04 +02:00
demo Initial release 2020-05-23 22:10:30 +02:00
docs Initial release 2020-05-23 22:10:30 +02:00
sphinx_nervproject_theme Update version 2020-05-27 15:54:04 +02:00
ui Initial release 2020-05-23 22:10:30 +02:00
.gitignore Initial release 2020-05-23 22:10:30 +02:00
AUTHORS Initial release 2020-05-23 22:10:30 +02:00
CHANGES Initial release 2020-05-23 22:10:30 +02:00
LICENSE Initial release 2020-05-23 22:10:30 +02:00
LICENSE-de Initial release 2020-05-23 22:10:30 +02:00
LICENSE-fr Initial release 2020-05-23 22:10:30 +02:00
LICENSE-nl Initial release 2020-05-23 22:10:30 +02:00
README.rst Update description and state 2020-05-27 15:52:24 +02:00
babel.cfg Initial release 2020-05-23 22:10:30 +02:00
requirements.txt Update requirements 2020-05-27 15:46:39 +02:00
setup.cfg Initial release 2020-05-23 22:10:30 +02:00
setup.py Update version 2020-05-27 15:54:04 +02:00

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

First build web assets:

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.

cd docs
make clean; make html

Website

To update website:

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

</html>