fabric-1.4.2 release incomplete docs content. #640

Closed
idella opened this Issue May 10, 2012 · 4 comments

Projects

None yet

4 participants

@idella
idella commented May 10, 2012

From the released tarball.

archtester fabric # ls /mnt/gen2/TmpDir/portage/dev-python/fabric-1.4.2//work/Fabric-1.4.2/docs/

api changelog.rst development.rst faq.rst index.rst installation.rst roadmap.rst tutorial.rst usage

Files conf.py, Makefile and folders _static and _templates from github not included.
Such a number makes wonder if the docs were not intended for building.

@bitprophet
Member

I'd consider merging a patch that updates MANIFEST.in to include the necessary components for doc building.

Typically we assume people building docs will be using the actual, full source code as obtained from Git or a Github tarball, and not the PyPI sdist, which is primarily intended for installing the Python code.

@Arfrever
--- MANIFEST.in
+++ MANIFEST.in
@@ -2,7 +2,9 @@
 include INSTALL
 include LICENSE
 include README
-recursive-include docs *.rst
+include doc/conf.py
+include doc/Makefile
+recursive-include docs *.css *.html *.rst
 recursive-exclude docs/_build *
 include fabfile.py
 include requirements.txt
@bitprophet
Member

#644's list is actually even better -- I finally went back and looked explicitly at our docs dir and yes -- we would want to include everything but _build for maximum usefulness to somebody obtaining just an sdist tarball. (The more explicit version in @Arfrever's diff works just as well, but I don't anticipate adding any files to docs that would not be needed to build the docs.)

I'll merge something in a minute.

@floppym
floppym commented May 17, 2012

Thanks for merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment