##################
sphinx-highlights
##################
.. start short_desc
**Sphinx extension to display a selection of highlights from a Python library.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/sphinx-highlights/latest?logo=read-the-docs
:target: https://sphinx-highlights.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-highlights/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-highlights/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-highlights/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/sphinx-highlights?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-highlights?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-highlights
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-highlights
:target: https://pypi.org/project/sphinx-highlights/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-highlights?logo=python&logoColor=white
:target: https://pypi.org/project/sphinx-highlights/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-highlights
:target: https://pypi.org/project/sphinx-highlights/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-highlights
:target: https://pypi.org/project/sphinx-highlights/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-highlights?logo=anaconda
:target: https://anaconda.org/domdfcoding/sphinx-highlights
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-highlights?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/sphinx-highlights
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-highlights
:target: https://github.com/sphinx-toolbox/sphinx-highlights/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-highlights
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-highlights/v0.6.0
:target: https://github.com/sphinx-toolbox/sphinx-highlights/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-highlights
:target: https://github.com/sphinx-toolbox/sphinx-highlights/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-highlights
:target: https://pypi.org/project/sphinx-highlights/
:alt: PyPI - Downloads
.. end shields
See `the documentation <https://sphinx-highlights.readthedocs.io/en/latest/demo.html>`_ for a demo.
Installation
--------------
.. start installation
``sphinx-highlights`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install sphinx-highlights
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install sphinx-highlights
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/sphinx-highlights",
"name": "sphinx-highlights",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "documentation,sphinx,sphinx-extension",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/95/26/5cdc86a8113c710e603dad17cd2daa911ee2b06cdf429b37f461b588214b/sphinx_highlights-0.6.0.tar.gz",
"platform": "Windows",
"description": "\n##################\nsphinx-highlights\n##################\n\n.. start short_desc\n\n**Sphinx extension to display a selection of highlights from a Python library.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/sphinx-highlights/latest?logo=read-the-docs\n\t:target: https://sphinx-highlights.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-highlights/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-highlights/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-highlights/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-highlights/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-highlights?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-highlights?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-highlights\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-highlights\n\t:target: https://pypi.org/project/sphinx-highlights/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-highlights?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-highlights/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-highlights\n\t:target: https://pypi.org/project/sphinx-highlights/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-highlights\n\t:target: https://pypi.org/project/sphinx-highlights/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-highlights?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/sphinx-highlights\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-highlights?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/sphinx-highlights\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-highlights\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-highlights\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-highlights/v0.6.0\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-highlights\n\t:target: https://github.com/sphinx-toolbox/sphinx-highlights/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-highlights\n\t:target: https://pypi.org/project/sphinx-highlights/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nSee `the documentation <https://sphinx-highlights.readthedocs.io/en/latest/demo.html>`_ for a demo.\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-highlights`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-highlights\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install sphinx-highlights\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension to display a selection of highlights from a Python library.",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://sphinx-highlights.readthedocs.io/en/latest",
"Homepage": "https://github.com/sphinx-toolbox/sphinx-highlights",
"Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-highlights/issues",
"Source Code": "https://github.com/sphinx-toolbox/sphinx-highlights"
},
"split_keywords": [
"documentation",
"sphinx",
"sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e46ba885a84bea689609e1f9a3110aa133902dd292e0b1ac3a60ee68ba702a50",
"md5": "61524fe65638f84aa9386d0e6e23eded",
"sha256": "523c1981a0ebf50ef861c30556f3fbd1d56a14900b38df63287294953d2c5282"
},
"downloads": -1,
"filename": "sphinx_highlights-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61524fe65638f84aa9386d0e6e23eded",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 26661,
"upload_time": "2024-03-17T08:27:37",
"upload_time_iso_8601": "2024-03-17T08:27:37.177483Z",
"url": "https://files.pythonhosted.org/packages/e4/6b/a885a84bea689609e1f9a3110aa133902dd292e0b1ac3a60ee68ba702a50/sphinx_highlights-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95265cdc86a8113c710e603dad17cd2daa911ee2b06cdf429b37f461b588214b",
"md5": "c9303363b087487ef449be1993ba4cd4",
"sha256": "ca22b3693aff80fbc4e1b23ee82510f5caa0e28255aa951d9ba97be7106c0541"
},
"downloads": -1,
"filename": "sphinx_highlights-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "c9303363b087487ef449be1993ba4cd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8599,
"upload_time": "2024-03-17T08:27:39",
"upload_time_iso_8601": "2024-03-17T08:27:39.107278Z",
"url": "https://files.pythonhosted.org/packages/95/26/5cdc86a8113c710e603dad17cd2daa911ee2b06cdf429b37f461b588214b/sphinx_highlights-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-17 08:27:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "sphinx-highlights",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "default-values",
"specs": [
[
">=",
"0.5.0"
]
]
},
{
"name": "dict2css",
"specs": [
[
">=",
"0.2.3"
]
]
},
{
"name": "docutils",
"specs": [
[
">=",
"0.16"
]
]
},
{
"name": "domdf-python-tools",
"specs": [
[
">=",
"2.9.0"
]
]
},
{
"name": "sphinx",
"specs": [
[
"<",
"5"
],
[
">=",
"3.2.0"
]
]
},
{
"name": "sphinx-panels",
"specs": [
[
">=",
"0.5.1"
]
]
},
{
"name": "sphinx-toolbox",
"specs": [
[
">=",
"2.13.0"
]
]
}
],
"tox": true,
"lcname": "sphinx-highlights"
}
JSON
