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

Uploaded Source

Built Distribution

default_values-0.7.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for default_values-0.7.0.tar.gz
Algorithm Hash digest
SHA256 f84e05a0f363173676872948ea864c90e3fcdbcfed2dcb7c23e75ab5083244d9
MD5 d6f2377169deeae26d78bd61508777e5
BLAKE2b-256 ba4716ba73764fa77c127e4a09efde2e24b6ce09007f514ef1a9b4f5d3ca988f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: default_values-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for default_values-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e347a1b5f755a8d88fa913949900014c66cfe44ae39343c173010272a94ce733
MD5 52f22a20feddd2e95e446867e97e65c4
BLAKE2b-256 4815e4ab161da7ff7a704773af911a4541c0dd2cce5903420b2637c24b9ba2b9

See more details on using hashes here.

Supported by

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