[devpi upload] with-docs option : support for --from-doc-dir about devpi

[devpi-bot]

Original comment by @hpk42

I wonder how to best do the configuration bit. Maybe adding a command line option to upload, and then adding a generic mechanism to add options to any devpi subcommand in setup.cfg would work nicely. Have to think a bit about the latter.

[devpi-bot]

Original comment by @lbrack

Do you mean that all actual parameters not parsed (parse_known_args) could be passed down to setup.py? I think this is a good idea. The debug mode should show how the sub-process is being invoked though.

[devpi-bot]

Original comment by @hpk42

Just did a commit https://bitbucket.org/hpk42/devpi/commits/a1720ea942cc20245abdf63ff459fd62faa27a87 which i think should fix your issue. I ended up not introducing a new option but rather creating the docs with an explicit internal build dir. Let me know if this works for you.

[devpi-bot]

Original comment by @lbrack

Looking at the code, it seems you assume that there is a folder in the current working directory called build which should contains the rst files? And that the output is under ./build/html. Am I correct?

#!python

build = cwd.join("build")
upload_dir = build.join("html")

We currently have the following structure.

docs/source/... # contains the rst files. Not a flat structure

We could obviously rename source for build but we do have many projects (>20) which already use this structure.

I am just thinking that other people may have non standard documentation location (and setup.py seems to support this it turns out).

Granted this is non standard and we don't want to clutter devpi with too many command line arguments.

Could we consider using an environment variable (yuk)?

#!bash

+This will build and upload sphinx-documentation by configuring and running
+this command::
+
+    setup.py build_sphinx -E --build-dir $SPHINX_BUILD_DIR \
Add a comment to this line
+             upload_docs --upload-dir $SPHINX_BUILD_DIR/html
+

which would be used if present?

[devpi-bot]

Original comment by @hpk42

The build_sphinx "--build-dir" option instructs sphinx to override any conf.py setting. We can thus pass the canonical "--upload-dir" to the upload_docs subcommand. So i think it should "just work", pending a reality check from your side :) Note that docs are accessible through the web by going to http://localhost:3141/root/dev/PKGNAME/+doc/ -- a link is also shown now on the index page http://localhost:3141/root/dev/

[devpi-bot]

Original comment by @lbrack

First of all I realize that I misunderstood something (obvious). I was actually wondering why you would use the term "build" to identify the rst sources. My bad.

It now make sense as far as the build output is concerned. I was wondering where the source where expected to be found (since the location is "non standard") and I found out that setup appears to scan the file system to discover a conf.py and initiate the build from there (this was the unknown for me).

So even without testing it, I can tell you that this fix works for us.