#2031 new enhancement

Optionally serve ./docs from the web gateway.

Reported by: nejucomo Owned by:
Priority: normal Milestone: undecided
Component: code-frontend-web Version: 1.10.0
Keywords: docs Cc:
Launchpad Bug:

Description

I was just updating ticket #1659 which is about the lack of documentation in python installations of LAFS.

I started looking into the "standard way" to bundle documentation into python package installs, and it seems like there is none! :-(

However, it occurred to me that it would be convenient for many users to have the docs served from gateway. It could even render .rst files to HTML.

Change History (4)

comment:1 in reply to: ↑ description Changed at 2013-07-22T22:51:13Z by daira

Replying to nejucomo:

However, it occurred to me that it would be convenient for many users to have the docs served from gateway. It could even render .rst files to HTML.

It could, but is this worth the packaging cost of rst2html?

(Without rendering as HTML, you wouldn't have links, so it would be strictly less useful than browsing https://github.com/tahoe-lafs/tahoe-lafs/tree/master/docs or https://tahoe-lafs.org/trac/tahoe-lafs/browser/trunk/docs.)

comment:2 Changed at 2013-07-22T22:51:59Z by daira

Well, perhaps not strictly less useful if you're offline.

comment:3 follow-up: Changed at 2013-07-22T22:58:17Z by daira

Perhaps add a script or make offline-docs Makefile target that assumes rst2html is installed, and dumps an HTML copy of the docs to BASEDIR/public_html?

comment:4 in reply to: ↑ 3 Changed at 2013-07-22T23:01:17Z by daira

Replying to daira:

Perhaps add a script or make offline-docs Makefile target that assumes rst2html is installed, and dumps an HTML copy of the docs to BASEDIR/public_html?

Ah, but then the docs would be tied to the basedir and not to the version of Tahoe-LAFS being run as the gateway, so that wouldn't satisfy the requirements of #1659.

Note: See TracTickets for help on using tickets.