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

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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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