[tahoe-lafs-trac-stream] [tahoe-lafs] #1659: setuptools/easy_install/pip-installed package lacks documentation

[tahoe-lafs]

#1659: setuptools/easy_install/pip-installed package lacks documentation
--------------------------+----------------------------
     Reporter:  nejucomo  |      Owner:  nobody
         Type:  defect    |     Status:  new
     Priority:  major     |  Milestone:  undecided
    Component:  unknown   |    Version:  1.9.0
   Resolution:            |   Keywords:  packaging pypi
Launchpad Bug:            |
--------------------------+----------------------------

Comment (by nejucomo):

 Here's a demo of the [https://github.com/nejucomo/tahoe-lafs/tree/1659
 -bundle-docs-in-sdist 1659-bundle-docs-in-sdist] branch using `pip` to
 install from a `git` repository:

 {{{
  $ git rev-parse --abbrev-ref HEAD ; git rev-parse HEAD
 1659-bundle-docs-in-sdist
 b0ca93b732ba47cdd14d9b70996525c7cc8c85a1


 $ TMP="$(mktemp --tmpdir -d 1659-bundle-docs-in-sdist.demo-XXXXXX)"


 $ virtualenv "$TMP"
 Using real prefix '/usr/local/bin/../stow/Python-2.7.3-setuptools-0.6c11'
 New python executable in /home/n/tmp/1659-bundle-docs-in-sdist.demo-
 I4S29A/bin/python
 Installing setuptools...............done.
 Installing pip.................done.


 $ source "$TMP/bin/activate"
 (1659-bundle-docs-in-sdist.demo-I4S29A)

 $ pip install twisted > $TMP/pip-install-twisted.log # necessary work
 around; see https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2032
 (1659-bundle-docs-in-sdist.demo-I4S29A)

 $ pip install . > $TMP/pip-install-dot.log
 (1659-bundle-docs-in-sdist.demo-I4S29A)

 $ cd "$VIRTUAL_ENV"
 (1659-bundle-docs-in-sdist.demo-I4S29A)

 $ ls ./share/doc/allmydata-tahoe/
 COPYING.GPL  COPYING.TGPPL.rst  CREDITS  docs  NEWS.rst  README.txt
 relnotes.txt
 (1659-bundle-docs-in-sdist.demo-I4S29A)

 $ find share/doc/ -type d
 share/doc/
 share/doc/zfec
 share/doc/pyutil
 share/doc/pycryptopp
 share/doc/allmydata-tahoe
 share/doc/allmydata-tahoe/docs
 share/doc/allmydata-tahoe/docs/historical
 share/doc/allmydata-tahoe/docs/frontends
 share/doc/allmydata-tahoe/docs/proposed
 share/doc/allmydata-tahoe/docs/specifications
 share/doc/allmydata-tahoe/docs/specifications/backends
 share/doc/allmydata-tahoe/docs/man
 (1659-bundle-docs-in-sdist.demo-I4S29A)
 }}}

-- 
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1659#comment:8>
tahoe-lafs <https://tahoe-lafs.org>
secure decentralized storage