Open jhlegarreta opened 1 year ago
We can use the same system as Slicer: (h/t @jcfr):
A possible path forward:
gh-pages
branchindex.html
page dynamically retrieving the available directories. See this page for an examlegh-pages
of this repository using action/checkout
and with path: "ITKDoxygen-gh-pages"
master
using action/checkout
specifying the ITK GitHub repo with `path: "ITK-master"``master
directorypush-git-subdirectory-as-branch
by specifying SQUASH_HISTORY
to true
Existing documentation archives could also be added as release assets to a release called Archives
created using https://gist.github.com/jcfr/9c0c0133c2d3fa2b029e6dd2648f7720
We should be able to have old releases deployed to GitHub Pages, keep the repository light, by
consolidate-documentation
step, that downloads and index of existing releases, the current nightly build
actions/deploy-pages
Documentation of older releases should be kept available on the website. Ideally, the latest/current commit could be displayed, but users should be able to choose and look up the documentation of older releases.
I know that the documentation of older releases is available at https://itk.org/download/, but I think users rarely download a documentation ZIP file to look at the corresponding documentation/the above would be appreciated.
Also, right now it is unclear that the online documentation refers to the latest/current commit (and not the displayed tag) unless one realizes about the build date at the bottom. This also happens with the stable documentation linked from itk.org https://itk.org/Doxygen/html/index.html