###############
default_values
###############
.. start short_desc
**Sphinx extension to show default values in documentation.**
.. end short_desc
For example:
.. code-block:: python
def namedlist(name: str = "NamedList") -> Callable:
"""
A factory function to return a custom list subclass with a name.
:param name: The name of the list.
:return:
"""
.. image:: https://default-values.readthedocs.io/en/latest/_images/after.png
For more information see `the documentation <https://default-values.readthedocs.io/en/latest/usage.html>`_.
.. 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/default-values/latest?logo=read-the-docs
:target: https://default-values.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/default_values/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/default_values/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/default_values/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/default_values/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/default_values/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/default_values/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/default_values/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/default_values?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/default_values?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/default_values
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/default_values
:target: https://pypi.org/project/default_values/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/default_values?logo=python&logoColor=white
:target: https://pypi.org/project/default_values/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/default_values
:target: https://pypi.org/project/default_values/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/default_values
:target: https://pypi.org/project/default_values/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/default_values?logo=anaconda
:target: https://anaconda.org/domdfcoding/default_values
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/default_values?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/default_values
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/default_values
:target: https://github.com/sphinx-toolbox/default_values/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/default_values
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/default_values/v0.6.0
:target: https://github.com/sphinx-toolbox/default_values/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/default_values
:target: https://github.com/sphinx-toolbox/default_values/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/default_values
:target: https://pypi.org/project/default_values/
:alt: PyPI - Downloads
.. end shields
|
Installation
--------------
.. start installation
``default_values`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install default_values
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 default_values
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/default_values",
"name": "default-values",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "documentation,sphinx",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/5b/68/04320385f5a78fd12d9b1372cdd093078543266f0f1a10d5936b2ad8b32e/default_values-0.6.0.tar.gz",
"platform": "Windows",
"description": "\n###############\ndefault_values\n###############\n\n.. start short_desc\n\n**Sphinx extension to show default values in documentation.**\n\n.. end short_desc\n\nFor example:\n\n\t.. code-block:: python\n\n\t\tdef namedlist(name: str = \"NamedList\") -> Callable:\n\t\t\t\"\"\"\n\t\t\tA factory function to return a custom list subclass with a name.\n\n\t\t\t:param name: The name of the list.\n\n\t\t\t:return:\n\t\t\t\"\"\"\n\n\t.. image:: https://default-values.readthedocs.io/en/latest/_images/after.png\n\nFor more information see `the documentation <https://default-values.readthedocs.io/en/latest/usage.html>`_.\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/default-values/latest?logo=read-the-docs\n\t:target: https://default-values.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/default_values/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/default_values/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/default_values/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/default_values/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/default_values/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/default_values/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/default_values/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/default_values?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/default_values?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/default_values\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/default_values\n\t:target: https://pypi.org/project/default_values/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/default_values?logo=python&logoColor=white\n\t:target: https://pypi.org/project/default_values/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/default_values\n\t:target: https://pypi.org/project/default_values/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/default_values\n\t:target: https://pypi.org/project/default_values/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/default_values?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/default_values\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/default_values?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/default_values\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/default_values\n\t:target: https://github.com/sphinx-toolbox/default_values/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/default_values\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/default_values/v0.6.0\n\t:target: https://github.com/sphinx-toolbox/default_values/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/default_values\n\t:target: https://github.com/sphinx-toolbox/default_values/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/default_values\n\t:target: https://pypi.org/project/default_values/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n|\n\nInstallation\n--------------\n\n.. start installation\n\n``default_values`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install default_values\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 default_values\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension to show default values in documentation.",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://default-values.readthedocs.io/en/latest",
"Homepage": "https://github.com/sphinx-toolbox/default_values",
"Issue Tracker": "https://github.com/sphinx-toolbox/default_values/issues",
"Source Code": "https://github.com/sphinx-toolbox/default_values"
},
"split_keywords": [
"documentation",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e98163daf83dd81f0400737588f4a1340ea756b35cbaa1e71d8652a47d297b5",
"md5": "0627fd0eb1527907b0dbe93397efc7dd",
"sha256": "91b51a0ccacbfe5b7d2a685c61b8ca4289f9c14dcbbddf7c1e11fe249f33f710"
},
"downloads": -1,
"filename": "default_values-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0627fd0eb1527907b0dbe93397efc7dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 22223,
"upload_time": "2023-07-26T09:39:49",
"upload_time_iso_8601": "2023-07-26T09:39:49.134738Z",
"url": "https://files.pythonhosted.org/packages/5e/98/163daf83dd81f0400737588f4a1340ea756b35cbaa1e71d8652a47d297b5/default_values-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b6804320385f5a78fd12d9b1372cdd093078543266f0f1a10d5936b2ad8b32e",
"md5": "d466f49699de1b82a70af7575d549340",
"sha256": "0f3a610d586754400da8c0d96f093248a7cd82e0e0324687412d4dc44b077df3"
},
"downloads": -1,
"filename": "default_values-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "d466f49699de1b82a70af7575d549340",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8012,
"upload_time": "2023-07-26T09:39:50",
"upload_time_iso_8601": "2023-07-26T09:39:50.761552Z",
"url": "https://files.pythonhosted.org/packages/5b/68/04320385f5a78fd12d9b1372cdd093078543266f0f1a10d5936b2ad8b32e/default_values-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-26 09:39:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "default_values",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "default-values"
}
JSON
