Other

additional_ignore

A list of additional entries for .gitignore.

Example:

additional_ignore:
  - "*.pyc"

Required: no

Default: [ ]

Type: Sequence of String

exclude_files

A list of files not to manage with repo_helper.

exclude_files:
  - conf
  - tox

Valid values are as follows:

Value

File(s) that will not be managed

lint_roller

lint_roller.sh

stale_bot

.github/stale.yml

auto_assign

.github/workflow/assign.yml and .github/auto_assign.yml

readme

README.rst

doc_requirements

doc-source/requirements.txt

pylintrc

.pylintrc

manifest

MANIFEST.in

setup

setup.py

pkginfo

__pkginfo__.py

conf

doc-source/conf.py

gitignore

.gitignore

rtfd

.readthedocs.yml

travis

.travis.yml

tox

tox.ini

test_requirements

tests_dir /requirements.txt

dependabot

.dependabot/config.yml

make_conda_recipe

make_conda_recipe.py

bumpversion

.bumpversion.cfg

issue_templates

.github/ISSUE_TEMPLATE/bug_report.md and .github/ISSUE_TEMPLATE/feature_request.md

404

<docs_dir>/not-found.png and <docs_dir>/404.rst

make_isort

isort.cfg

Required: no

Default: [ ]

Type: Sequence of String

imgbot_ignore

A list of additional glob ignores for imgbot.

Example:

imgbot_ignore:
  - "**/*.svg"

Required: no

Default: [ ]

Type: Sequence of String

pkginfo_extra

A list of lines of Python code to add to the top of conf.py. These could be additional settings for Sphinx or calls to extra scripts that must be executed before building the documentation.

pkginfo_extra:
  - import datetime
  - print(datetim.datetime.today())

Required: no

Default: [ ]

Type: Sequence of String

yapf_exclude

A list of regular expressions to use to exclude files and directories from autoformatting.

Example:

yapf_exclude:
  - ".*/templates/.*"

Required: no

Default: [ ]

Type: Sequence of String

pre_commit_exclude

Regular expression for files that should not be checked by pre_commit.

pre_commit_exclude: "^.*\\._py$"

Required: no

Default: ^$

Type: String

desktopfile

A key value mapping of entries for a Linux .desktop file.

desktopfile:
  Exec: wxIconSaver
  Icon: document-save

Version, Name and Comment are pre-populated from version, modname and short_desc.

New in version 2020.11.15.

Required: no

Default: { }

Type: Mapping of String to String