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

Uploaded Source

Built Distribution

default_values-0.5.2-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for default_values-0.5.2.tar.gz
Algorithm Hash digest
SHA256 5b892477865ce2f396a3752e61a4fd0360618dec1a1cf8571de1f4f6778dfb60
MD5 2ad220f7370f6c79f5d598d49e1ed27e
BLAKE2b-256 f1b77cf4ee3a7b1d3c01194dd872b2d3e8aad19b4a16c7caff55f97150cf72cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for default_values-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7d388f6f71ec09fa13c2f604ac67b13246942fc971d97cdd6d22f7e9e67fe5b0
MD5 a5a5e4485ba19d4c0fdadb216072c263
BLAKE2b-256 fcd0cf1706be791b39b4f54c08f39a096342d862baa566a0c982f37410c7e363

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