Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-20839

Fix version switcher for Sphinx technotes in non-main editions

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None

      Description

      For a Sphinx technote, in any edition other than the main edition the URL that the version switcher provides is incorrect (it's a relative URL). The solution is likely to make the version dashboard URL either absolute or relative to the root (check if our routing supports this).

      See https://github.com/lsst-sqre/lsst_dd_rtd_theme/blob/master/lsst_dd_rtd_theme/layout.html#L97

        Attachments

          Issue Links

            Activity

            Hide
            ktl Kian-Tat Lim added a comment -

            I think /v is always correct, no? Doesn't need scheme or host.

            Show
            ktl Kian-Tat Lim added a comment - I think /v is always correct, no? Doesn't need scheme or host.
            Hide
            jsick Jonathan Sick added a comment -

            I've released lsst-dd-rtd-theme 0.2.2 to PyPI which uses the /v link, which our Fastly configuration does indeed handle.

            I've also released documenteer 0.5.4 to use lsst-dd-rtd-theme==0.2.2. I've also backported this change to the 0.4.x series of documenteer (documenteer 0.4.6) so that existing technotes can automatically pick up on this fix.

            As editions are refreshed, the sidebar links will get naturally updated. I don't think it's necessary to spend the time triggering Travis builds on each and every technote edition created to date.

            I've also updated the technote_rst template to include the documenteer 0.5.x series in its requirements.txt file

            Show
            jsick Jonathan Sick added a comment - I've released lsst-dd-rtd-theme 0.2.2 to PyPI which uses the /v link, which our Fastly configuration does indeed handle. I've also released documenteer 0.5.4 to use lsst-dd-rtd-theme==0.2.2. I've also backported this change to the 0.4.x series of documenteer (documenteer 0.4.6) so that existing technotes can automatically pick up on this fix. As editions are refreshed, the sidebar links will get naturally updated. I don't think it's necessary to spend the time triggering Travis builds on each and every technote edition created to date. I've also updated the technote_rst template to include the documenteer 0.5.x series in its requirements.txt file

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick, Kian-Tat Lim
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: