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.3.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

default_values-0.5.3-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: default_values-0.5.3.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for default_values-0.5.3.tar.gz
Algorithm Hash digest
SHA256 b8a3b623b45615392f1ef597500115618770013aab5d50f8818e6fe5b30cea3d
MD5 c21c536458b8e04618414c1165cf503a
BLAKE2b-256 5669d8485f1ec6ab6cc7f2c94fafff785dce4d7963eb84595debb840bca8f5aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for default_values-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 025cc3a46f32421ed58e6eebc451f419ac14a3509aa94352c575668ea125adf0
MD5 b2018f83493362be8b1d0e13dcd1a2f6
BLAKE2b-256 402c4162b699f1f01e4108b0f3e2e4dabf2626a82770a4d3381f79af39ce3f4f

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