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

pypiserver accepts documentation uploads but does not save docs #47

Closed
pete-theobald opened this issue Feb 25, 2014 · 7 comments
Closed

Comments

@pete-theobald
Copy link

Not sure how pypiserver is meant to behave with upload_docs but it looks wrong to me.

I am building package docs using sphinx and then running the upload_docs command to upload them to my pypiserver (apache2 and wsgi). I get a 200 response saying that everything went well, but I cannot find the documentation saved on the server and not visible in the index.

Scenario 1 - pypiserver does not support documentation uploads. If this is the case it would be good if it returned a 501 not implemented response so people knew
Scenario 2 - pypiserver is accepting the upload_docs command but is hiding the documentation somewhere. The documentation could be uploaded to describe where the docs get saved, how to view them in the web interface and how to change the documentation folder.

I'd be happy to add some code to do either if theres an agreement on which if these options is correct.

Pete

@rmohr
Copy link

rmohr commented Feb 25, 2014

pypiserver does not support this. It just checks if the archive is valid and returns 200, if so.

See https://github.com/schmir/pypiserver/blob/0f601fcd/pypiserver/_app.py#L127

I implemented a simple server in http://github.com/rmohr/sphinx-server which does exclusively that. I always wanted to start integrating it into pypiserver, maybe you can reuse some of my stuff there (tests, ...), or the server can be integrated in a useful way.

@schmir
Copy link
Contributor

schmir commented Feb 25, 2014

support for doc uploads has been added in 623c0dc. Vinay did need that for developing his distlib package.

@rmohr
Copy link

rmohr commented Feb 26, 2014

Correct me if I am mistake, isn't this the the code i was referring to? As far as i can see, it does not save the zip file anywhere, it just checks the archive and returns 200 if the archive is valid.

@schmir
Copy link
Contributor

schmir commented Feb 26, 2014

@rmohr yes, that's right.

@pete-theobald
Copy link
Author

Thanks for the clarification, I'll have a look through it and see what I
can do. A couple of ideas

  1. The code for checking the zip contents looks fine, thanks for clarifying.
  2. It would be really useful for me if the zip file could be unzipped into
    a documentation folder. I'll have a go at that now.
    Pete

On 26 February 2014 08:42, Ralf Schmitt notifications@github.com wrote:

@rmohr https://github.com/rmohr yes, that's right.

Reply to this email directly or view it on GitHubhttps://github.com//issues/47#issuecomment-36102962
.

@schmir
Copy link
Contributor

schmir commented Feb 26, 2014

@pete-theobald please don't do that. I think this functionality is out of scope for pypiserver. I'd like to keep it short. The package upload funtionality was already a bit too much for me (since I was perfectly happy with scp'ing packages), but I could see that some people may find this useful.

I don't think uploading docs and allowing to view them in pypiserver brings enough value to the table in order to justify the newly added code - even if it's just a few lines.

You may want to take a look at devpi-server.

@schmir schmir closed this as completed Feb 26, 2014
@schmir
Copy link
Contributor

schmir commented Feb 26, 2014

ok, I still need to document that...reopening

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants