Opened 6 years ago

Closed 5 years ago

#3438 enhancement closed invalid (invalid)

Being able to link to howtos in different subprojects

Reported by: thijs Owned by: spiv
Priority: normal Milestone:
Component: lore Keywords:
Cc: thijs Branch:
Author: Launchpad Bug:

Description

From #1404: In a subproject howto, there's no way to express a link to a howto in a different subproject. This is a documentation generation issue.

Change History (3)

comment:1 Changed 6 years ago by glyph

As far as I know there is a way to do this. If the link were expressed in the lore source as "../../core/howto/defer.xhtml", some invocations of lore would work properly with it.

There's currently some (undocumented?) reshuffling of documents as part of the release process; I believe they're in a different structure on the website than in the download.

I'd like to resolve this by simply re-organizing the documentation generation process to be simply invoking 'lore' with no arguments in the 'doc' directory, which will (among other benefits) make relative links work properly. This is the way it originally worked on Twisted, and the way it currently works in Mantissa trunk. I don't think it would be too much work to do that.

(Now, there might be a separate feature which would allow arbitrary projects to link to each others' documentation in Lore somehow, but that's a different story entirely.)

comment:2 Changed 5 years ago by radix

Right, so this ticket is invalid: it is possible to do cross-subproject links, by using "../"*N as glyph suggested. There is no bug with lore here.

We do have a problem with the *deployment* of documentation on the web site, which I've created #4044 for.

comment:3 Changed 5 years ago by radix

  • Resolution set to invalid
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.