Include additional files in the package.
Review Request #9477 — Created Jan. 10, 2018 and submitted
Djblets 1.0 introduced SVG icons, which was used for higher DPIs. This
never made it into the resulting package, though, since these files were
left out of the manifest. While working to fix this, I noticed several
other files that were missing, such as*.map
files and the
*-requirements.txt
files.This change carefully reworks our
MANIFEST.in
to better control what
files are included in the package. We now start by including the
entirety of thecontrib
,djblets
, anddocs
directories, along with
some other specific files, and then selectively remove content from the
package. This gives us the various files like*.map
and*.svg
, while
keeping out files like*.py
and vim swap files.Some other files, like
INSTALL
andREADME
, are now specifically
included. These were included before by default by setuptools, but
they've been added so that we can be more explicit about our coverage.Files needed for building docs are also now present, allowing us to
build docs without needing a Git source tree.
Built packages before and after this change. Verified that the SVGs,
Map files, and requirements.txt files were included, and nothing was
missing.Carefully inspected the file listings between what we've previously
shipped and now, and against the source tree.Built all the docs from a source tree.
- Change Summary:
-
Added missing files needed to build docs.
- Description:
-
Djblets 1.0 introduced SVG icons, which was used for higher DPIs. This
never made it into the resulting package, though, since these files were left out of the manifest. This change adds those in, fixing high-DPI icons and building packages against non-source Djblets installs. Some additional cleanups were made. The include lines are more specific
about the locations of the files being included. The requirements.txt files are also included, helping with building against source installations. Some additional files (such as README and INSTALL) are also specifically mentioned, though that's more for completeness, as ~ those files are automatically brought in for packages. ~ those files are automatically brought in for packages. Files needed to + build the docs are also now included, allowing doc building outside of + the Git repository. - Testing Done:
-
Built packages before and after this change. Verified that the SVGs and
requirements.txt files were included, and nothing was missing. + + Built all the docs from a source tree.
- Commit:
-
d1ddc31172a25b76d4f35f2c6eba5773a9121e3627a080ef78cbac60c22ad134b7bf9813ba7acbb6
- Diff:
-
Revision 2 (+9 -1)
Checks run (2 succeeded)
- Change Summary:
-
- Simplified the file, opting to include everything by default (so nothing
is missed), and then excluding things. - More files/directories are now removed by default.
- Simplified the file, opting to include everything by default (so nothing
- Description:
-
Djblets 1.0 introduced SVG icons, which was used for higher DPIs. This
never made it into the resulting package, though, since these files were ~ left out of the manifest. This change adds those in, fixing high-DPI ~ icons and building packages against non-source Djblets installs. ~ left out of the manifest. While working to fix this, I noticed several ~ other files that were missing, such as *.map
files and the+ *-requirements.txt
files.~ Some additional cleanups were made. The include lines are more specific
~ about the locations of the files being included. The requirements.txt ~ files are also included, helping with building against source ~ installations. Some additional files (such as README and INSTALL) are ~ also specifically mentioned, though that's more for completeness, as ~ those files are automatically brought in for packages. Files needed to ~ build the docs are also now included, allowing doc building outside of ~ the Git repository. ~ This change carefully reworks our
MANIFEST.in
to better control what~ files are included in the package. We now start by including the ~ entirety of the contrib
,djblets
, anddocs
directories, along with~ some other specific files, and then selectively remove content from the ~ package. This gives us the various files like *.map
and*.svg
, while~ keeping out files like *.py
and vim swap files.~ ~ Some other files, like
INSTALL
andREADME
, are now specifically+ included. These were included before by default by setuptools, but + they've been added so that we can be more explicit about our coverage. + + Files needed for building docs are also now present, allowing us to
+ build docs without needing a Git source tree. - Testing Done:
-
~ Built packages before and after this change. Verified that the SVGs and
~ requirements.txt files were included, and nothing was missing. ~ Built packages before and after this change. Verified that the SVGs,
~ Map files, and requirements.txt files were included, and nothing was + missing. + + Carefully inspected the file listings between what we've previously
+ shipped and now, and against the source tree. Built all the docs from a source tree.
- Commit:
-
27a080ef78cbac60c22ad134b7bf9813ba7acbb6d36235929cf4b00961244fdc39639fd67d21af0f
- Diff:
-
Revision 3 (+13 -4)