Metadata-Version: 2.1
Name: default-values
Version: 0.4.0
Summary: Sphinx extension to show default values in documentation.
Home-page: https://github.com/domdfcoding/default_values
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: MIT License
Project-URL: Documentation, https://default_values.readthedocs.io
Project-URL: Issue_Tracker, https://github.com/domdfcoding/default_values/issues
Project-URL: Source_Code, https://github.com/domdfcoding/default_values
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: docutils (>=0.16)
Requires-Dist: sphinx (>=3.0.3)
Provides-Extra: all

###############
default_values
###############

.. start short_desc

**Sphinx extension to show default values in documentation.**

.. end short_desc


.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Docs
	  - |docs| |docs_check|
	* - Tests
	  - |travis| |actions_windows| |actions_macos| |coveralls| |codefactor|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires| |pre_commit|

.. |docs| image:: https://img.shields.io/readthedocs/default_values/latest?logo=read-the-docs
	:target: https://default_values.readthedocs.io/en/latest/?badge=latest
	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/domdfcoding/default_values/workflows/Docs%20Check/badge.svg
	:target: https://github.com/domdfcoding/default_values/actions?query=workflow%3A%22Docs+Check%22
	:alt: Docs Check Status

.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/default_values/master?logo=travis
	:target: https://travis-ci.com/domdfcoding/default_values
	:alt: Travis Build Status

.. |actions_windows| image:: https://github.com/domdfcoding/default_values/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/default_values/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Tests Status

.. |actions_macos| image:: https://github.com/domdfcoding/default_values/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/default_values/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Tests Status

.. |requires| image:: https://requires.io/github/domdfcoding/default_values/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/default_values/requirements/?branch=master
	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/default_values/master?logo=coveralls
	:target: https://coveralls.io/github/domdfcoding/default_values?branch=master
	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/default_values?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/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

.. |license| image:: https://img.shields.io/github/license/domdfcoding/default_values
	:target: https://github.com/domdfcoding/default_values/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/default_values
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/default_values/v0.4.0
	:target: https://github.com/domdfcoding/default_values/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/default_values
	:target: https://github.com/domdfcoding/default_values/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
	:alt: Maintenance

.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
	:target: https://github.com/pre-commit/pre-commit
	:alt: pre-commit

.. end shields

|

Installation
--------------

.. start installation

``default_values`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install default_values

.. end installation


