Giters

pypiserver / pypiserver

Minimal PyPI server for uploading & downloading packages with pip/easy_install

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pypiserver accepts documentation uploads but does not save docs

pete-theobald opened this issue · comments

commented

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

commented

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.

commented

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

commented

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.

commented

@rmohr yes, that's right.

commented

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
.

commented

@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.

commented

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