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>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-nervproject-theme",
"maintainer": "kujiu, ptitgnu",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Nerv Project ASBL <contact@nerv-project.eu>",
"keywords": "sphinx, doc, theme",
"author": "kujiu, ptitgnu",
"author_email": "Nerv Project ASBL <contact@nerv-project.eu>",
"download_url": "https://files.pythonhosted.org/packages/84/72/51c087678562fc40e8b9cd27dc50d39043bdfe7e08afefd3be4e1fef3f95/sphinx_nervproject_theme-3.0.3.tar.gz",
"platform": null,
"description": "Sphinx NervProject Theme\n========================\n\nA modern responsive theme for python's `Sphinx <http://www.sphinx-doc.org>`_ documentation generator based on\nsphinx_press_theme and ablog.\n\nThis theme is based on `VuePress <https://vuepress.vuejs.org/>`_.\nIt uses `Vue.js <https://vuejs.org/>`_ and LessCSS managed by\n`webpack <https://webpack.js.org>`_ through `vue-cli <https://cli.vuejs.org/>`_.\n\n\nUsage\n~~~~~\n\nOn Sphinx project's `conf.py`: set the theme name to `nervproject`.\n\n.. code:: python\n\n html_theme = \"nervproject\"\n\nSee details on `Sphinx theming docs <http://www.sphinx-doc.org/en/master/theming.html#using-a-theme>`_.\n\nDevelopment\n~~~~~~~~~~~\n\nTo rebuild web assets:\n\n.. code:: bash\n\n npm run build\n\nInstall theme locally with `pip install -e .`.\n\n`docs` folder contains theme's own documentantion.\n\n.. code:: bash\n\n cd docs\n make clean; make html\n\nCompatibility\n~~~~~~~~~~~~~\n\nThis theme needs CSS vars enabled in the browser, so\nit doesn't work on IE. Four color variations are\navailable :\n\n- light low contrast (default) ;\n- light high contrast ;\n- dark low contrast ;\n- dark high contrast.\n\nThe good one is used based on prefers-contrast and\nprefers-color-scheme media queries. This is automatically\ndone by a compatible browser. If not, the default theme\nis used. Some browsers need manual configuration like\nChromium on Linux (a flag to enable for all websites).\n\nExample\n~~~~~~~\n\nSee the `Nerv Project's web site <https://www.nerv-project.eu>`_\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx-doc theme based on Vuepress",
"version": "3.0.3",
"project_urls": {
"changelog": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme/raw/branch/main/CHANGES.rst",
"editor": "https://www.nerv-project.eu",
"homepage": "https://www.nerv-project.eu",
"issues": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme/issues",
"repository": "https://procrastinator.nerv-project.eu/nerv-project/sphinx_nervproject_theme"
},
"split_keywords": [
"sphinx",
" doc",
" theme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5155bf6c2def2acad984c5bd606361115be9da7b1f738578215ff746bbdedfb",
"md5": "6ae2ef77af2de61798b1275f537706c3",
"sha256": "6d2592ee118a6568c214c3fef46d605818677a6ba9cc926533795a556a32f59e"
},
"downloads": -1,
"filename": "sphinx_nervproject_theme-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ae2ef77af2de61798b1275f537706c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1525915,
"upload_time": "2024-07-29T12:46:32",
"upload_time_iso_8601": "2024-07-29T12:46:32.816930Z",
"url": "https://files.pythonhosted.org/packages/c5/15/5bf6c2def2acad984c5bd606361115be9da7b1f738578215ff746bbdedfb/sphinx_nervproject_theme-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "847251c087678562fc40e8b9cd27dc50d39043bdfe7e08afefd3be4e1fef3f95",
"md5": "beecb45697e70137fa330099487c41d0",
"sha256": "645eeb189d8f4b760b836a92ddcfbec23605390847924d935db01422471e7860"
},
"downloads": -1,
"filename": "sphinx_nervproject_theme-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "beecb45697e70137fa330099487c41d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1537241,
"upload_time": "2024-07-29T12:46:36",
"upload_time_iso_8601": "2024-07-29T12:46:36.410868Z",
"url": "https://files.pythonhosted.org/packages/84/72/51c087678562fc40e8b9cd27dc50d39043bdfe7e08afefd3be4e1fef3f95/sphinx_nervproject_theme-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 12:46:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-nervproject-theme"
}
JSON