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/49/19/8f7bd0f0bcd49091cf84f77bc33004d440c68d8ed9c7caea66c5ccfc2873/sphinx_nervproject_theme-3.0.2.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",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx-doc theme based on Vuepress",
"version": "3.0.2",
"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": null,
"digests": {
"blake2b_256": "0dc948cf03dd039535976708fef19b7bea531dbf29baa6f4cc8f0c0b31954788",
"md5": "37490e40149eac27aab00811cf36e20e",
"sha256": "4c992ee6b34cfed0022b29d7075347d2ad9c21572ef8609d62d12ce010182363"
},
"downloads": -1,
"filename": "sphinx_nervproject_theme-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37490e40149eac27aab00811cf36e20e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1513203,
"upload_time": "2023-09-27T16:10:17",
"upload_time_iso_8601": "2023-09-27T16:10:17.546465Z",
"url": "https://files.pythonhosted.org/packages/0d/c9/48cf03dd039535976708fef19b7bea531dbf29baa6f4cc8f0c0b31954788/sphinx_nervproject_theme-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "49198f7bd0f0bcd49091cf84f77bc33004d440c68d8ed9c7caea66c5ccfc2873",
"md5": "610f10ede8ec281534b45713f47b96ec",
"sha256": "d46124e3a397eaa8f465deec7e4a4e12a71fe4b6b52bbb12b983ab7596b087a9"
},
"downloads": -1,
"filename": "sphinx_nervproject_theme-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "610f10ede8ec281534b45713f47b96ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1526255,
"upload_time": "2023-09-27T16:10:21",
"upload_time_iso_8601": "2023-09-27T16:10:21.429473Z",
"url": "https://files.pythonhosted.org/packages/49/19/8f7bd0f0bcd49091cf84f77bc33004d440c68d8ed9c7caea66c5ccfc2873/sphinx_nervproject_theme-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 16:10:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx_nervproject_theme"
}
JSON