Skip to content

Conversation

thewtex
Copy link
Member

@thewtex thewtex commented Jan 17, 2025

Publish the CI builds to the latest GitHub Release. The artifacts are formatted to follow other ITK release doxygen artifacts.

Also publish to ReadTheDocs. This provides:

  • Access via a global CDN (fast, responsive anywhere in the world).
  • Easy-access to multiple versions.
  • Nicer search.
  • Analytics on which pages are visited / classes are used the most.

There will be a lag of 1 build between publishing to GitHub Releases and publishing to RTD, i.e. RTD will be updated the next day.

I went through all the old releases and curated them (consistent organization, naming, reduced PNG sizes so they would fit in the releases, removed the old footers) and published them to RTD. There is a WIP: RTD stub commit that I would normally rebase/squash, but it should be retained so the subsequent commits can be kept for RTD versions.

Supercedes #2
Closes #9 #4

Left over from port from SimpleITK.
Copy link

@phcerdan phcerdan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@thewtex thewtex merged commit 4706dc6 into InsightSoftwareConsortium:main Jan 17, 2025
2 checks passed
@jhlegarreta
Copy link
Member

Thank you @thewtex 🚀 ❤️ !!

@dzenanz
Copy link
Member

dzenanz commented Jan 17, 2025

Thank you!

@dzenanz
Copy link
Member

dzenanz commented Jan 17, 2025

Will all these releases be available on the main docs site, as is e.g. v5.3?

@thewtex
Copy link
Member Author

thewtex commented Jan 17, 2025

@dzenanz all the release documentation are published here:

https://docs.itk.org/projects/doxygen

image

And tarballs are in the ITKDoxygen repository GitHub Releases.

@jhlegarreta
Copy link
Member

https://github.com/InsightSoftwareConsortium/ITKDoxygen/tags:

Were the double vv's vv1.1.0 and vv1.2.0 intentional @thewtex ?

@thewtex
Copy link
Member Author

thewtex commented Jan 20, 2025

@jhlegarreta Yes, 👍 those were unintentional -- removed 🔢

@jhlegarreta
Copy link
Member

💯 Thanks Matt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create GitHub Releases with HTML, XML, Tag, archives
4 participants