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/python-drf-spectacular-sidecar-nonfree.git
    cd python-drf-spectacular-sidecar-nonfree
    gbp buildpackage --git-pbuilder


Notes about used section non-free
=================================

The binary packages are placed within the section non-free just for one but
important reason.

The source contains minimized JS files in the folder
drf_spectacular_sidecar/static/drf_spectacular_sidecar/{redoc,swagger-ui}
which are originally created by the build process of the Redoc and Swagger-UI.

Currently both source projects are not packaged in Debian nor is it possible
to rebuild the minimized from any other source source even if some source is
available in Debian main (see below).

Redoc
https://github.com/Redocly/redoc

Swagger-UI
https://github.com/swagger-api/swagger-ui

We can't rebuild the shipped *.min.js files right now nor there is a way to
work around this circumstance. If someone can provide useful information how
to deal better with a potential rebuild at build time please get in contact!

Have a look at the copyright file for more and some detailed information on
specific files in question.

Potential missing source in Debian
----------------------------------

mark.js                  (redoc)
react.production.js      (redoc)
Redocly/redoc            (redoc)
stickyfill               (redoc)

swagger-ui

Available source in Debian
--------------------------

classnames        (redoc)     https://tracker.debian.org/pkg/node-classnames
dompurify         (redoc)     https://tracker.debian.org/pkg/node-dompurify
object-assign     (redoc)     https://tracker.debian.org/pkg/node-object-assign
perfect-scrollbar (redoc)     https://tracker.debian.org/pkg/ruby-rails-assets-perfect-scrollbar
prismjs           (redoc)     https://tracker.debian.org/pkg/node-prismjs

react-dom.production.js  (redoc)  https://tracker.debian.org/pkg/node-react
react-is.production.js   (redoc)  https://tracker.debian.org/pkg/node-react
scheduler.production.js  (redoc)  https://tracker.debian.org/pkg/node-react

uri.js            (redoc)     https://tracker.debian.org/pkg/node-uri-js

 -- Carsten Schoenert <c.schoenert>  Fri, 26 May 2023 17:12:00 +0200
