This package is maintained with git-buildpackage(1). It follows DEP-14 for
branch naming (e.g. using debian/master for the current version in Debian
unstable due Debian Python team policy).

It uses pristine-tar(1) to store enough information in git to generate bit
identical tarballs when building the package without having downloaded an
upstream tarball first.

When working with patches it is recommended to use "gbp pq import" to import
the patches, modify the source and then use "gbp pq export --commit" to commit
the modifications.

The changelog is generated using "gbp dch" so if you submit any changes don't
bother to add changelog entries but rather provide a nice git commit message
that can then end up in the changelog.

It is recommended to build the package with pbuilder using:

    gbp buildpackage --git-pbuilder

For information on how to set up a pbuilder environment see the git-pbuilder(1)
manpage. In short:

    DIST=sid git-pbuilder create
    gbp clone https://salsa.debian.org/python-team/packages/pytkdocs.git
    cd pytkdocs
    gbp buildpackage --git-pbuilder


Upstream tests
==============
The internal test suite is disabled currently, the tests need some packages to
be packaged in Debian.
From a first look the following packages (see 'tests' in pyproject.toml) are
need to get prepared:

pytest-randomly

The build of the documentation requires also some mkdocs plugin(s) to get
packged for getting the MkDocs based documentation build.

mkdocs-coverage

 -- Carsten Schoenert <c.schoenert@t-online.de>  Thu, 12 Sep 2024 07:55:00 +0200
