Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Including doc and tests in source distributions #479

Closed
sbraz opened this issue May 13, 2020 · 4 comments
Closed

Including doc and tests in source distributions #479

sbraz opened this issue May 13, 2020 · 4 comments

Comments

@sbraz
Copy link
Contributor

sbraz commented May 13, 2020

Hi again Eric,
I'm about to add wand to Gentoo and, now that I'm done with the tests, I have one more question: what do you think of adding doc and tests to source distributions?

Gentoo (and I think Debian as well) tend to rely on PyPI tarballs instead of GitHub's for building packages and since we run tests / build docs, we need those to be present.

I normally create a PR for that kind of issue but seeing how it will decuple the tarball size, I thought it would be wiser to ask you first.

Additional question: do you plan on releasing a new version soon? I'm especially interested in the float test fix and the removal of README.rst from data_files. If not, it's no problem; I'll backport the individual patches.

@emcconville
Copy link
Owner

emcconville commented May 13, 2020

what do you think of adding doc and tests to source distributions?

I've got more requests to remove docs & tests from distributions then anything else. I agree with your request, but feel defeated as the user-community seems split.

However, perhaps a PR against the setup.py is all that's needed.

do you plan on releasing a new version soon?

I'm about done with it. Regression testing is done, and finishing up the docs now. I can cut the 0.6.0 release at anytime, but if you want to offer a patch, I can wait.

@sbraz
Copy link
Contributor Author

sbraz commented May 13, 2020

but if you want to offer a patch, I can wait.

The only things I noticed are those two sphinx warnings:

checking consistency... /tmp/wand/docs/whatsnew/0.5.rst: WARNING: document isn't included in any toctree
/tmp/wand/wand/display.py:docstring of wand.display:14: WARNING: unknown option: python -m

I tried the following but it doesn't get rid of the first:

diff --git a/docs/changes.rst b/docs/changes.rst
index 22c7823..1616e8e 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -326,6 +326,11 @@ Version 0.5.0
 
 Released on January 1, 2019.
 
+.. seealso::
+
+   :doc:`whatsnew/0.5`
+      This guide introduces what's new in Wand 0.5.
+
 - Support for ImageMagick-7.
 - Improved support for 32-bit systems.
 - Improved support for non-Q16 libraries.

As for the second warning, I don't really know how to fix it.

@emcconville
Copy link
Owner

emcconville commented May 13, 2020

I've got the first warning fixed, and the last one came about with recent Sphinx updates -- but is benign. I'll take a look at the PR shortly, and will close this issue aftwards. Should be able to wrap things up by tomorrow.

@emcconville
Copy link
Owner

emcconville commented May 14, 2020

Heads up. Wand 0.6.0 will release in the next 8 to 12 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants