[tahoe-lafs-trac-stream] [Tahoe-LAFS] #2835: links in INSTALL don't work on both github and readthedocs

Tahoe-LAFS trac at tahoe-lafs.org
Wed Sep 28 08:15:51 UTC 2016


#2835: links in INSTALL don't work on both github and readthedocs
---------------------------+------------------------
 Reporter:  warner         |          Owner:
     Type:  defect         |         Status:  new
 Priority:  normal         |      Milestone:  1.12.0
Component:  documentation  |        Version:  1.11.0
 Keywords:                 |  Launchpad Bug:
---------------------------+------------------------
 Currently, `docs/INSTALL.rst` uses {{{`about.rst`_}}} and {{{..
 _about.rst: about.rst}}} to generate a hyperlink to `docs/about.rst` (and
 the same for `windows.rst` and `OS-X.rst`). This works for github's RST
 renderer, but yields broken links on [http://tahoe-
 lafs.readthedocs.io/en/latest/INSTALL.html Read The Docs].

 [02362ae] changed this from {{{:doc:`about`}}}, which worked on Read The
 Docs but not on github.

 We need a syntax that works on both renderers.

 I'd like to get this fixed for 1.12, but I'm willing to drop it if nobody
 has a bright idea about how to make it work in both places.

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2835>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage


More information about the tahoe-lafs-trac-stream mailing list