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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: default_values-0.6.0.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.6.0.tar.gz
Algorithm Hash digest
SHA256 0f3a610d586754400da8c0d96f093248a7cd82e0e0324687412d4dc44b077df3
MD5 d466f49699de1b82a70af7575d549340
BLAKE2b-256 5b6804320385f5a78fd12d9b1372cdd093078543266f0f1a10d5936b2ad8b32e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for default_values-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91b51a0ccacbfe5b7d2a685c61b8ca4289f9c14dcbbddf7c1e11fe249f33f710
MD5 0627fd0eb1527907b0dbe93397efc7dd
BLAKE2b-256 5e98163daf83dd81f0400737588f4a1340ea756b35cbaa1e71d8652a47d297b5

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