Not possible to build documentation in offline mode

[vorlock]

Hi guys,

I'd like to generate documentation on deb build time but it's not possible due fetching dependencies like sphinx from pypi or checking git metadata when build process is not using git repo but pristine tarball.

Do you think you could adjust docs generation process to work in entirely offline mode based on tarball?

[vorlock]

Also do you think you could consider below patch for excluding installation of files from docs directory which are causing problems as they are being installed directly to /usr/lib/python2.7/dist-packages/docs/ what in case of __init.py__ is a quite big issue.

patch (is below) I can also create PR if you'll be interested in merging it:

From: Marcin Kulisz <[email protected]>
Date: Tue, 10 Nov 2015 18:20:00 +0000
Subject: Excluding docs from binary package

---
 setup.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index fd9f995..a0e4854 100644
--- a/setup.py
+++ b/setup.py
@@ -13,7 +13,7 @@ def find_version(path):

 setup(name='bootstrap-vz',
       version=find_version(os.path.join(os.path.dirname(__file__), 'bootstrapvz/__init__.py')),
-      packages=find_packages(),
+      packages=find_packages(exclude=['docs']),
       include_package_data=True,
       entry_points={'console_scripts': ['bootstrap-vz = bootstrapvz.base:main',
                                         'bootstrap-vz-remote = bootstrapvz.remote.main:main',

[myhro]

Hi Marcin,

I do agree that the documentation should not be part of the package (either deb or pip tarball) itself. But shouldn't we need to generate a documentation package later? I don't remember if we had talked about it earlier, but I've experienced some problems building the Sphinx docs myself.

[vorlock]

Hi Tiago,

I managed to build docs (to be honest don't remember how). Even if right not we're not having bootstrap-vz-doc I'm thinking about adding it in the future as whole app is growing and becoming more complicated and some people are offline and could use it. So I think it'd be nice to have ability to build docs off line with single command just using tarball as a source.

In relation to patch I posted earlier I'm going to use it to fix RC bug which has been reported due to issue which this patch is fixing, it's not a biggy but I thought that it may be useful for other channels of distribution as well not just for debs.

[myhro]

Even if right not we're not having bootstrap-vz-doc I'm thinking about adding it in the future as whole app is growing and becoming more complicated and some people are offline and could use it.

It is nice to read the documentation offline, but the part of actually using bootstrap-vz entirely offline is a little bit more complicated. Although it is possible to bootstrap an image using a local mirror or cached packages, there are plugins (like docker_daemon) and providers (like azure and gce) which downloads data from other sources.

In relation to patch I posted earlier I'm going to use it to fix RC bug which has been reported due to issue which this patch is fixing, it's not a biggy but I thought that it may be useful for other channels of distribution as well not just for debs.

I'd like to see if Anders agree to strip out the documentation from the tarball, but if he's OK with this can you send a Pull Request later?

Thank you, Marcin.

[vorlock]

It is nice to read the documentation offline, but the part of actually using bootstrap-vz entirely offline is a little bit more complicated. Although it is possible to bootstrap an image using a local mirror or cached packages, there are plugins (like docker_daemon) and providers (like azure and gce) which downloads data from other sources.

I understand this. I'm not pushing for entirely offline build process just docs (at least for now :-) )

but if he's OK with this can you send a Pull Request later?

sure I can

[andsens]

checking git metadata when build process is not using git repo but pristine tarball.

What part does that?

I'd like to see if Anders agree to strip out the documentation from the tarball, but if he's OK with this can you send a Pull Request later?

I'm fine with this. Although I think the docs should eventually be built alongside the rest as man pages.

[vorlock]

checking git metadata when build process is not using git repo but pristine tarball.

What part does that?

Maybe not exactly git metadata but still expecting that workspace is a git repo: https://github.com/andsens/bootstrap-vz/blob/master/docs/conf.py#L309-L313

I'm fine with this. Although I think the docs should eventually be built alongside the rest as man pages.

I agree

[andsens]

Maybe not exactly git metadata but still expecting that workspace is a git repo

Ah yes. Totally forgot about that part. Well we could just default to master or we could supply a setting specifying the commit hash to use. Those lines allow sphinx to link to the correct version of the source online.