Skip to content

Commit

Permalink
Merge pull request InsightSoftwareConsortium#5145 from thewtex/releas…
Browse files Browse the repository at this point in the history
…e-major-var

DOC: Clarify MAJOR_VERSION is a variable
thewtex authored Jan 20, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
2 parents 06484b7 + 47f646e commit 259ad17
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/Maintenance/Release.md
Original file line number Diff line number Diff line change
@@ -719,16 +719,16 @@ Generate Doxygen Documentation
Note: links to the nightly generated Doxygen can be found in the footer of the
Doxygen HTML pages. Use the files to upload and create:

* `InsightDoxygenDocTag-MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.gz`
* `InsightDoxygenXml-MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.tar.gz`
* `InsightDoxygenDocHtml-MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.tar.gz.`
* `InsightDoxygenDocTag-$MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.gz`
* `InsightDoxygenXml-$MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.tar.gz`
* `InsightDoxygenDocHtml-$MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION.tar.gz.`

Prior to the release, new `Remote` modules should be enabled in the Doxygen
build's configuration.

Download the tarballs from the `latest` [ITKDoxygen Release] and rename the files to use
the current version. Create a new [ITKDoxygen Release] with the files on a
`vMAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION` tag.
`v$MAJOR_VERSION.$MINOR_VERSION.$PATCH_VERSION` tag.

ReadTheDocs will automatically generate a new rendered version based on this
tagged release.

0 comments on commit 259ad17

Please sign in to comment.