Optionally serve ./docs from the web gateway. #2031

New Issue

nejucomo · 2013-07-20T19:00:53Z

nejucomo commented

2013-07-20 19:00:53 +00:00

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.

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

nejucomo added the

labels 2013-07-20 19:00:53 +00:00

nejucomo added this to the undecided milestone 2013-07-20 19:00:53 +00:00

daira commented

2013-07-22 22:51:13 +00:00

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

Replying to [nejucomo](/tahoe-lafs/trac-2024-07-25/issues/7061): > 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>.)

daira commented

2013-07-22 22:51:59 +00:00

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

daira commented

2013-07-22 22:58:17 +00:00

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?

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`?

daira commented

2013-07-22 23:01:17 +00:00

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.

Replying to [daira](/tahoe-lafs/trac-2024-07-25/issues/2031#issuecomment-92667): > 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.

Sign in to join this conversation.