Setuptools: Documentation no longer updated during release

[jaraco]

After switching to Warehouse for uploads in #589, the docs fail to upload with this error:

running upload_docs
Submitting documentation to https://upload.pypi.io/legacy/
Upload failed (404): Not Found

Looks like the upload_docs command defers to the repository specified for the upload command, but warehouse doesn't support that interface.

[jaraco]

@dstufft: Is doc upload support something that warehouse plans to support? Will it have a different default URL?

[dstufft]

The plan is to remove documentation hosting and direct people towards things like RTD.

[jaraco]

Specifying a repository in upload_docs doesn't work. It seems that the command still uses the repository specified in the upload section.

[jaraco]

I was wrong. Setting the repository in upload_docs _does_ work, but it seems that the Travis docs uploader is re-using the 'server' parameter when uploading docs. If you believe the code, the server option isn't even used but instead -r pypi is passed to twine. Still, pypi_server is being passed to upload_docs, and that's the same value that's used to define the server for -r pypi, so it seems there's no way to differentiate from the server used to upload dists and the server used to upload docs.

[jaraco]

Looks like RTD has a setuptools project, but I don't own it, and it is currently rendering a stub page. Looks like getting docs to publish on RTD is going to require its own effort.

[dstufft]

I think I own that project.

[dstufft]

@jaraco is your name on RTD jaraco?

[jaraco]

@dstufft, it is.

[dstufft]

Now you're on that project too! Also if you get RTD working for setuptools, we can add it so the domain is setuptools.pypa.io for the docs.

[jaraco]

The issue above is blocking me from releasing the docs on RTD, and I've spent enough time today shaving this yak. The repo is currently in an inconsistent state, where it's not building on RTD but also won't build with setup.py build_docs, but I'm just going to leave it like that for now and hope the RTD solution can work at some point.

[jaraco]

@dstufft, can you configure setuptools.pypa.io to point to RTD as you mentioned earlier?

[jaraco]

@dstufft, on second thought, maybe better to host as readthedocs.io in order to use their certificate and host with HTTPS. Thoughts?

[dstufft]

We have https for all pypa.io. I can set it up tomorrow.

Sent from my iPhone

On Jun 3, 2016, at 9:40 PM, Jason R. Coombs [email protected] wrote:

@dstufft, on second thought, maybe better to host as readthedocs.io in order to use their certificate and host with HTTPS. Thoughts?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

[jaraco]

okay. cool. I've set up a redirect from https://pythonhosted.org/setuptools to https://setuptools.readthedocs.io, but I can update that when pypa.io is serving the docs.

[asottile]

Seems RTD isn't up to date for the 26.x release

[jaraco]

Yes, it seems there are multiple steps to getting a project set up on RTD. Even after configuring the project in RTD, one has to install the webhook, which references a deprecated process, but I've added it anyway:

I'll manually build the latest docs and hope that this fixes the issue.

[jaraco]

I'm going to close this issue, as it's already addressed a number of aspects of a transition. Let's open new tickets if there are issues with RTD not getting updated or if someone wants to revive the effort to use pypa.io as the docs domain.

[bignose-debian]

@dstufft:

The plan is to remove documentation hosting and direct people towards things like RTD.

A web search for “pypi hosting documentation” gives plenty of information about ‘upload_docs’ as a currently supported service, and no clear response about that plan to remove the service.

Can you make these plans – including how a package currently using ‘upload_docs’ should be changed – widely known where we can direct people who ask?

[jaraco]

Also ref https://github.com/pypa/python-packaging-user-guide/pull/266