form_ltd_edition_name

documenteer.sphinxconfig.utils.form_ltd_edition_name(git_ref_name=None)

Form the LSST the Docs edition name for this branch, using the same logic as LTD Keeper does for transforming branch names into edition names.

Parameters:

git_ref_name (str) – Name of the git branch (or git ref, in general, like a tag) that.

Notes

The LTD Keeper (github.com/lsst-sqre/ltd-keeper) logic is being replicated here because Keeper is server side code and this is client-side and it’s not yet clear this warrants being refactored into a common dependency.

See keeper.utils.auto_slugify_edition.