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

Provide docs with source distribution #137

Closed
nedbat opened this issue Jun 19, 2011 · 6 comments
Closed

Provide docs with source distribution #137

nedbat opened this issue Jun 19, 2011 · 6 comments
Labels
enhancement New feature or request install

Comments

@nedbat
Copy link
Owner

nedbat commented Jun 19, 2011

Originally reported by jenisys (Bitbucket: jenisys, GitHub: jenisys)


VERSION: coverage-3.5b1 and older

It would be helpful if the sphinx-based documentation would be supplied w/ the source package. This makes offline usage of coverage slightly simpler.

NOTE:
Similar things can be said with the provided tests.
Tests are currently missing in source distribution.


@nedbat
Copy link
Owner Author

nedbat commented Nov 18, 2012

This is fixed in <<changeset 9433196c39e7 (bb)>>. I included the *.rst files so the docs could be read. I didn't include everything needed to build the docs. Is that what you intended?

@nedbat
Copy link
Owner Author

nedbat commented Sep 6, 2015

I reversed this in a8037d8de732 (bb). I don't understand how these are useful for people. Get in touch if you can explain it to me.

@nedbat
Copy link
Owner Author

nedbat commented Sep 22, 2015

Original comment by Ben Finney (Bitbucket: bignose, GitHub: bignose)


Well, I don't understand why you reversed it :-) so not sure exactly what you need explained.

Not knowing what exactly you need explained, I can only say: The documentation sources are part of the code base's source, so building the documentation needs those sources; so the sources need to be in the source distribution.

@nedbat
Copy link
Owner Author

nedbat commented Sep 22, 2015

@BigNose The .rst files were in the .tar.gz, but were ignored by setup.py. They weren't copied anywhere during installation. My (perhaps limited) understanding of the .tar.gz file is that it is only used for running setup.py, in which case those files were useless.

Are there people who do other things with a .tar.gz file? It was never intended to be a complete copy of the working tree.

@nedbat
Copy link
Owner Author

nedbat commented Oct 10, 2015

Reconsidering.

@nedbat
Copy link
Owner Author

nedbat commented Oct 13, 2015

Re-fixed in e3b3db80e9bd (bb).

@nedbat nedbat closed this as completed Oct 13, 2015
@nedbat nedbat added major enhancement New feature or request install labels Jun 23, 2018
agronholm added a commit to agronholm/coveragepy that referenced this issue Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request install
Projects
None yet
Development

No branches or pull requests

1 participant