Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-13260

[Doc] Host different released versions of the documentation + version switcher

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: In Progress
    • Major
    • Resolution: Unresolved
    • None
    • 8.0.0
    • Documentation
    • None

    Description

      Related to ARROW-1299 for hosting the nightly docs, we could also keep the built docs for older versions instead of overwriting them at each release.

      Currently, the built docs live in the apache/arrow-site repo (asf-site branch) in the "/docs/" subdirectory.

      When releasing, we could add the newly built docs for that release in a subdirectory instead. Something like "/docs/5.0/" or "/docs/version/5.0".
      (And we could retroactively add some docs of previous releases, if we want)

      To make this useful for the user, we need a version switcher in the sphinx theme layout. There are other projects that use the same sphinx theme that have added this (see eg https://mne.tools/stable/index.html), and there is some work to upstream this to the base theme (but on the short term we could also copy such a custom implementation).

      For the "stable" docs (latest release), we could either 1) keep a duplicated version of the latest built docs at "/docs/", or 2) symlink "/docs/" to "/docs/5.0/" (and update this for each release; although I am not sure this is possible since it's the other is a child directory).
      We could also add a "/docs/stable/" and make this the default url.

      cc amol- kszucs

      Attachments

        Issue Links

          Activity

            People

              jorisvandenbossche Joris Van den Bossche
              jorisvandenbossche Joris Van den Bossche
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

                Created:
                Updated:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 12h 20m
                  12h 20m