Skip to main content

Sphinx extension to show default values in documentation.

Project description

Sphinx extension to show default values in documentation.

For example:

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:
        """
https://default-values.readthedocs.io/en/latest/_images/after.png

For more information see the documentation.

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status


Installation

default_values can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install default_values

To install with conda:

  • First add the required channels

$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
  • Then install

$ conda install default_values

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

default_values-0.5.1.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

default_values-0.5.1-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file default_values-0.5.1.tar.gz.

File metadata

  • Download URL: default_values-0.5.1.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for default_values-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a264af98d5498ad2ee509349db0fb2193e464d11e35e9525e27e1bc55e64bc14
MD5 52439830a8e4af32d1d01c9c2bc29bd6
BLAKE2b-256 eee4d16774e6180226ddaf47e8096d8c3650cb588775372db2a744fa5baf6f7b

See more details on using hashes here.

File details

Details for the file default_values-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for default_values-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d100e208ff853fa32cda0f8b36598ef7e4862b5e772f93a6f07cfcbcfa9a064c
MD5 9d003f6323963760206cd3ce449b51e7
BLAKE2b-256 a46270915859dcf2c9ec4d58c91766c2641ef2fceeeffba596726acfc1b0cc1d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page