Ticket #2713 (closed defect: wontfix)

Opened 2 years ago

Last modified 10 months ago

setup.py installs tests, but not documentation

Reported by: glyph Assigned to:
Priority: high Milestone:
Component: Nevow Severity: normal
Keywords: Cc:
Estimated Completion (YYYY/MM/DD): Branch: branches/skip-howtotests-2713
Author: exarkun

Description

This is failing on buildbot already.

Not only does setup.py need to be fixed: the example tests need a more robust way of locating the path to the documentation so that the listings can be tested as installed.

A first step might be to simply skip the example tests when installed if no documentation directory is present, but then a separate ticket should be filed.

We are about to have this problem with Mantissa as well.

Change History

12/03/08 18:35:09 changed by exarkun

  • priority changed from normal to high.
  • completion_estimate_date changed.

Once this is resolved, the two nevowinstall columns on buildbot should actually be green. We're pretty close, it'd be great to get all the way there. :)

01/23/09 20:55:07 changed by zooko

Hm... [17018] was intended to fix this. It does appear to have fixed it when setuptools is used to install, e.g. http://buildbot.divmod.org/builders/linux32-py2.4-nevowinstall/builds/76/steps/select_2/logs/stdio , but not when setuptools is not, e.g.: http://buildbot.divmod.org/builders/linux32-py2.4-nevowinstall/builds/76/steps/select/logs/stdio

Hm, I wonder why setuptools and distutils behave differently with data_files. Inspection of the stdout logs shows that doing setup.py install with setuptools installs the "chattutorial" files: http://buildbot.divmod.org/builders/linux32-py2.4-nevowinstall/builds/76/steps/shell_8/logs/stdio and {{{setup.py install without doesn't: http://buildbot.divmod.org/builders/linux32-py2.4-nevowinstall/builds/76/steps/shell_6/logs/stdio .

I wonder if adding all those files to a MANIFEST or MANIFEST.in would make distutils install them.

05/20/09 09:04:15 changed by exarkun

  • branch set to branches/skip-howtotests-2713.
  • branch_author set to exarkun.

(In [17289]) Branching to 'skip-howtotests-2713'

05/20/09 09:06:54 changed by exarkun

(In [17290]) Skip these tests if the howto listings cannot be found

refs #2713

05/20/09 10:40:38 changed by exarkun

  • keywords set to review.
  • owner deleted.

Changes in the branch remove these failures by turning them into skips.

I can't think of any suitable modifications to make to any distutils files to cause these docs to be installed, since the way distutils installs things, there's no sensible place to put the files (arguably the place setuptools puts them is not sensible either, but it still puts them there).

05/21/09 09:36:53 changed by exarkun

  • status changed from new to closed.
  • resolution set to wontfix.

Since I'm not actually fixing this ticket - installing the documentation - I've filed #2883 for the fix I made here.

Further, since actually installing the docs reliably is a really, really hard problem, I'm going to make the prediction that this is not going to be done in the foreseeable future and indicate that by closing this ticket as wontfix. If someone wants to figure out how to do this (on Windows, on OS X, on the various Linux distros, etc), great, please re-open this ticket.

05/21/09 09:37:02 changed by exarkun

  • keywords deleted.
jethro@divmod.org