kgaughan / docserver

Documentation server

Hi there 👋

docserver's Issues

Command lines argument parser for standalone use running with wsgiref.

This is a convenience for anybody who simply wants to grab docserver.py and run it without any additional setup. getopt will be fine.

Multiple bundle versions.

It would be nice to be able to have bundles for different versions of the same library side-by-side. While currently technically possible, the affordances available if support for this was added correctly is lacking. It would be nice to have a Read the Docs-style navigation bar to display the various versions side-by-side. Additionally, it would be nice to be able to group versions together on the frontpage.

Installation instructions

Write some installation instructions, including instructions for running it under Paste and as a standalone process.

Standalone template

Part of the point of using pystache is so the frontpage template can be customised for various installations of the application. However, the template is currently hardwired.

Upload logging

Docserver ought to be writing out successful uploads to a log.

Bundle downloads

There are two reasons for using zipfile. First is to allow bundle replacement to be atomic. The second is to make bundle downloads trivial.

The frontpage should display links to bundle download links and functionality to allow for downloading should be added to docserver itself.

Authentication support.

It would be nice if docserver could authenticate off of some backend, such as an LDAP server, a htpasswd/htdigest file, or some other authentication method.

Nicer titles

It ought to be possible to provide nicer titles to bundles. For that, we'll need some way to store metadata.

I think I'll store the metadata for a given bundle in .bundle-name.meta, which will just be a series of key/value pairs. The title can go under the 'title' key.

To extract the title initially, we can open up the bundle, open the index.html file within it, and search for the first

element, and extract the title from this.

Include bundle timestamp on frontpage

Self-explanatory, really.