-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Consider adding the docs to the distributed tarball #1209
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
Comments
Does your build process include running the doc build itself (e.g., using sphinx) or would you also like the generated HTML files/images? My main concern with bundling in docs is that the source tarball on pypi would increase from ~300KB to ~9MB. But most folks installing directly from PyPI are probably using the wheel anyways, so maybe this is not such a serious concern after all. |
The build process does run Sphinx so only the source suffices. You don't need to ship a build of the documentation. Indeed wheels should be the preferred mean of installation. |
Linux distributions such as Debian usually source upstream Python code from PyPI. In order to produce the accompanying documentation package, I would need the source of the documentation to be distributed in future uploaded tarballs. To achieve this, please consider adding a
recursive-include docs *
entry to theMANIFEST.in
file of the project.Thanks,
Ghis
The text was updated successfully, but these errors were encountered: