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.0b1.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

default_values-0.5.0b1-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file default_values-0.5.0b1.tar.gz.

File metadata

  • Download URL: default_values-0.5.0b1.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for default_values-0.5.0b1.tar.gz
Algorithm Hash digest
SHA256 bf000bc3ee700eb424b5550e295ea62d5bb98fd43140dac671cb9a4de3563ed8
MD5 8c5ff05ef54644dbd7af074712107cf0
BLAKE2b-256 4c216951e07999252db5c8abf9983bc5c77b2b1f28e006ab18ff08837bf29f57

See more details on using hashes here.

File details

Details for the file default_values-0.5.0b1-py3-none-any.whl.

File metadata

  • Download URL: default_values-0.5.0b1-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for default_values-0.5.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 2af3ad3442d9ccce748d507802d96732cc6c3f3f799ea8f3945340ac053c83f3
MD5 39bbb8bf8f1b3e109ade2dfc265d846a
BLAKE2b-256 34afb4a29a22e9bd0e5d4058c843e64d1347fb04c6adaf5a3e909de592c7f0e3

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