Conda & Anaconda

conda_channels

A list of Anaconda channels required to build and use the Conda package.

Example:

conda_channels:
  - domdfcoding
  - conda-forge
  - bioconda

Required: no

Default: [ ]

Type: Sequence of String

on_conda_forge

Flag to indicate the package is available on conda-forge.

If this flag is True the documentation will recommend installing from conda-forge over the primary_conda_channel.

If enable_conda if False but this option is True the documentation regarding installing with conda will still be shown.

Example:

on_conda_forge: True

New in version 2025.6.3.

Required: no

Default: False

Type: Boolean

primary_conda_channel

The Conda channel the package can be downloaded from.

This is automatically added to conda_channels.

Defaults to username if unset.

Example:

username: repo-helper
primary_conda_channel: domdfcoding

New in version 2020.12.17.

Required: no

Default: The value of username

Type: String

conda_extras

A list of extras (see extras_require) to include as requirements in the Conda package.

The special keyword all indicates all extras should be included.

The special keyword none indicates no extras should be included.

Example:

conda_extras:
  - plotting
  - xml

New in version 2020.11.12.

Required: no

Default: [‘all’]

Type: Sequence of String

conda_description

A short description of the project for Anaconda.

Example:

conda_description: This is a short description of my project.

A list of required Anaconda channels is automatically appended.

Required: no

Default: The value of short_desc

Type: String

enable_conda

Whether conda packages should be built and deployed.

If enable_conda if True the documentation regarding installing with conda (from the conda-forge channel) will be shown regardless.

Example:

enable_conda: True

Required: no

Default: True

Type: Boolean