Place doc sources in repo - for Debian building about imageio

[almarklein]

cc @ghisvail

[ghisvail]

I believe you have 2 options here:

• add the content of the docs/ folder to setup.py package_data attribute
  or
• use a MANIFEST.in file

Since you seem to be using a single master branch, I'd propose you just branch out from the 1.0 commit, add the docs, tag it as 1.0+docs and merge back to HEAD. You probably don't need to release 1.0+docs to PyPI. For me, the tag is enough to consider it an official tarball for Debian.

Cheers,

[almarklein]

I'll get on it asap. I have another small issue to fix that helps make imageio easier to adopt. Will probably release a 1.0.1 by the end of this week.

[ghisvail]

Hi Almar, any updates on this ? Otherwise, I can just submit the pkg for 1.0.0 and later make an update to it with 1.0.1 with the documentation included.

Cheers,

[almarklein]

Sorry about the delay. I guess I was hoping I could fix the test thing as well. Anyway, there is now a tag v1.0+docs that has a setup.py that also puts docs and tests in the dist package.

[almarklein]

... and I used data_files instead of package_data, so the files end up in the dist package, but or not installed. Let me know whether this does the trick.

[ghisvail]

It seems that building the sphinx documentation sill requires to download external resources. So it still fails with v1.0.0+docs.

PYTHONPATH=. http_proxy='127.0.0.1:9' sphinx-build -N -bhtml docs/ build/html
Making output directory...
Running Sphinx v1.2.3

Exception occurred:
  File "/tmp/buildd/imageio-1.0+docs/imageio/core/fetching.py", line 115, in _fetch_file
    'Dataset fetching aborted (%s)' % (url, e))
IOError: Error while fetching file https://github.com/imageio/imageio-binaries/raw/master/freeimage/libfreeimage-3.16.0-linux64.so.
Dataset fetching aborted (<urlopen error [Errno -2] Name or service not known>)

[almarklein]

Ah yes. The docs makes a lot of use of autodoc, so imageio is imported, which triggers a download. So I guess we need the no-internet-required version for this too. I am working on it #45.

[ghisvail]

FYI, I submitted v1.0 for inclusion in Debian, without the test suite and documentation. I notified that you were working to include them in future releases.