Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation no longer updated during release #604

Closed
jaraco opened this Issue Jun 3, 2016 · 19 comments

Comments

Projects
None yet
4 participants
@jaraco
Copy link
Member

jaraco commented Jun 3, 2016

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

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

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

@dstufft

This comment has been minimized.

Copy link
Member

dstufft commented Jun 3, 2016

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

@jaraco jaraco closed this in 01e1054 Jun 3, 2016

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

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

@jaraco jaraco reopened this Jun 3, 2016

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

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

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

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

This comment has been minimized.

Copy link
Member

dstufft commented Jun 3, 2016

I think I own that project.

@dstufft

This comment has been minimized.

Copy link
Member

dstufft commented Jun 3, 2016

@jaraco is your name on RTD jaraco?

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

@dstufft, it is.

@dstufft

This comment has been minimized.

Copy link
Member

dstufft commented Jun 3, 2016

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

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 3, 2016

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 added a commit that referenced this issue Jun 4, 2016

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 4, 2016

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

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 4, 2016

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

@dstufft

This comment has been minimized.

Copy link
Member

dstufft commented Jun 4, 2016

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 notifications@github.com 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

This comment has been minimized.

Copy link
Member Author

jaraco commented Jun 4, 2016

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

This comment has been minimized.

Copy link

asottile commented Aug 30, 2016

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

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Sep 15, 2016

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:

screen shot 2016-09-15 at 10 06 20

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

@jaraco

This comment has been minimized.

Copy link
Member Author

jaraco commented Sep 15, 2016

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

This comment has been minimized.

Copy link

bignose-debian commented Apr 4, 2017

@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

This comment has been minimized.

Copy link
Member Author

jaraco commented Apr 5, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.