https://github.com/sphinx-toolbox/default_values
Sphinx extension to show default values in documentation.
https://github.com/sphinx-toolbox/default_values
documentation python sphinx sphinx-extension
Last synced: 5 months ago
JSON representation
Sphinx extension to show default values in documentation.
- Host: GitHub
- URL: https://github.com/sphinx-toolbox/default_values
- Owner: sphinx-toolbox
- License: mit
- Created: 2020-07-25T16:51:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-12-26T19:18:33.000Z (6 months ago)
- Last Synced: 2025-12-28T07:45:55.475Z (6 months ago)
- Topics: documentation, python, sphinx, sphinx-extension
- Language: Python
- Homepage: https://default-values.readthedocs.io/en/latest
- Size: 512 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
###############
default_values
###############
.. start short_desc
**Sphinx extension to show default values in documentation.**
.. end short_desc
For example:
.. code-block:: python
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:
"""
.. image:: https://default-values.readthedocs.io/en/latest/_images/after.png
For more information see `the documentation `_.
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/default-values/latest?logo=read-the-docs
:target: https://default-values.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/default_values/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/default_values/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/default_values/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/default_values/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/default_values/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/default_values/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/default_values/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/default_values/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/default_values/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/default_values?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/default_values?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/default_values
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/default-values
:target: https://pypi.org/project/default-values/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/default-values?logo=python&logoColor=white
:target: https://pypi.org/project/default-values/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/default-values
:target: https://pypi.org/project/default-values/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/default-values
:target: https://pypi.org/project/default-values/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/default_values?logo=anaconda
:target: https://anaconda.org/domdfcoding/default_values
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/default_values?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/default_values
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/default_values
:target: https://github.com/sphinx-toolbox/default_values/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/default_values
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/default_values/v0.7.0
:target: https://github.com/sphinx-toolbox/default_values/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/default_values
:target: https://github.com/sphinx-toolbox/default_values/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2026
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/default-values
:target: https://pypistats.org/packages/default-values
:alt: PyPI - Downloads
.. end shields
|
Installation
--------------
.. start installation
``default_values`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install default-values
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install default_values
.. end installation