Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dynamically populate previous versions menu in the Doxygen HTML pages #3806

Open
jhlegarreta opened this issue Dec 19, 2022 · 3 comments
Open
Labels
type:Documentation Documentation improvement or change

Comments

@jhlegarreta
Copy link
Member

Description

The Doxygen documentation corresponding to the previous ITK releases should be accessible through a dynamically populated menu in the HTML pages.

Expected information

Existing previous releases are dynamically loaded in the HTML page.

Actual information

Existing previous releases are hard-coded in the HTML page.

Versions

master.

Additional Information

See #3804 (comment).

@jhlegarreta jhlegarreta added the type:Documentation Documentation improvement or change label Dec 19, 2022
@dzenanz
Copy link
Member

dzenanz commented Dec 19, 2022

This might be more trouble than it is worth. Automating this is not trivial, and the list is 5-10 items long. Manual update is probably fine. We should put it to release checklist.

@jhlegarreta
Copy link
Member Author

Automating this is not trivial, and the list is 5-10 items long.

I did no mean that this should be easy/I ignore how difficult it is. It may not be an issue for a few versions, but it will be an issue at some point in time.

Excerpt from a discourse admin thread:

A follow-up on this. Related topic in the VTK discourse saying that the VTK do also have the same issue:
https://discourse.vtk.org/t/about-missing-vtk-doxygen-documentation/9926

and that ParaView folks have found a way to have the documentation of different versions available:
https://kitware.github.io/paraview-docs/latest/cxx/

@blowekamp
Copy link
Member

This might be more trouble than it is worth. Automating this is not trivial, and the list is 5-10 items long. Manual update is probably fine. We should put it to release checklist.

IMHO the bigger reason to dynamically update the versions in the footer from all Doxygen from a single file, is to automatically update the old versions to have links to the newest versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Documentation Documentation improvement or change
Projects
None yet
Development

No branches or pull requests

3 participants