Demos for “extras_require” sphinx extension

extras_require_demos.pkginfo_subpackage

This is an example of defining requirements in a __pkginfo__.py file.

It was created with the following code:

.. extras-require:: extra_b
    :__pkginfo__:

Attention

This module has the following additional requirements:

click<7.1.2
flask>=1.1.2
sphinx==3.0.3

These can be installed as follows:

python -m pip install extras-require-demos[extra_b]

Functions:

function_b(arg1[, arg2, arg3])

This function does something

function_b(arg1, arg2=0, arg3='abc')

This function does something

Parameters

• arg1 (any) – An argument

• arg2 (int) – An integer argument. Default 0.

• arg3 (str) – A string argument. Default 'abc'.

extras_require_demos.requirements_txt_subpackage

This is an example of defining requirements in a requirements.txt file.

It was created with the following code:

.. extras-require:: extra_a
    :file: requirements_txt_subpackage/requirements.txt

Attention

This module has the following additional requirements:

numpy>=1.18.4
pandas!=1.0.0,>=0.25.0
scipy==1.4.1

These can be installed as follows:

python -m pip install extras-require-demos[extra_a]

Functions:

function_a(arg1[, arg2, arg3])

This function does something

function_a(arg1, arg2=0, arg3='abc')

This function does something

Parameters

• arg1 (any) – An argument

• arg2 (int) – An integer argument. Default 0.

• arg3 (str) – A string argument. Default 'abc'.

extras_require_demos.setup_cfg_subpackage

This is an example of defining requirements in a setup.cfg file.

It was created with the following code:

.. extras-require:: extra_c
    :setup.cfg:

Attention

This module has the following additional requirements:

faker
pytest
tox

These can be installed as follows:

python -m pip install extras-require-demos[extra_c]

Functions:

function_c(arg1[, arg2, arg3])

This function does something

function_c(arg1, arg2=0, arg3='abc')

This function does something

Parameters

• arg1 (any) – An argument

• arg2 (int) – An integer argument. Default 0.

• arg3 (str) – A string argument. Default 'abc'.

extras_require_demos.manual_subpackage

This is an example of defining requirements manually.

It was created with the following code:

.. extras-require:: extra_c

    pytz >=2019.1

Attention

This module has the following additional requirement:

pytz>=2019.1

This can be installed as follows:

python -m pip install extras-require-demos[extra_c]

Functions:

function_d(arg1[, arg2, arg3])

This function does something

function_d(arg1, arg2=0, arg3='abc')

This function does something

Parameters

• arg1 (any) – An argument

• arg2 (int) – An integer argument. Default 0.

• arg3 (str) – A string argument. Default 'abc'.