Uploading Documentation

[dstufft]

We need a sane way to upload documentation to PyPI

[merwok]

There’s a simple HTTP interface which is documented on the Python wiki and implemented in setuptools and distutils2.

[jenisys]

But "python setup.py upload_docs" has the same problem as the setup.py upload command.
+1

[merwok]

How so? You build and inspect the docs as you like, then use upload_docs to upload the existing files.

[sigmavirus24]

@merwok I believe @jenisys is referring to using unverified HTTPS connections at best, and HTTP at worst.

[jenisys]

With the following pypi configuration:

# -- FILE: $HOME/.pypirc
# setup.py upload, upload_docs commands require at least an empty "password" attribute. 
# Otherwise, they fail BADLY.

[pypi]                                                                          
repository: https://pypi.python.org/pypi                                        
username:<my_username>
password:                                            

When I run the following command after building the docs:

$ python setup.py upload_docs -r pypi 
running upload_docs
Submitting documentation to https://pypi.python.org/pypi
Upload failed (401): Incorrect password
# -- AS EXPECTED: Empty password is not correct.

REASON: upload_docs command requires also a cleartext password in ".pypirc", like the "upload" command (as expected).

If am doing something wrong, please correct me.
But I had the impression, that twine wanted to solve that problem (and therefore asks for passwords). Or might retrieve the password from a keyring, ...

[sigmavirus24]

The last time I spoke to @dstufft about this we came to the conclusion that this isn't something we wish to support anymore.