Story
Description
Rather than waste time remembering to bump versions for docs in the docs directory. We should pull that information automatically from git tags. This has been done before in LF tooling projects so we can port that into MD-SAL.
# The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. command = 'git describe --tags --long --dirty' try: git_version = format_version( subprocess.check_output(command.split()).decode('utf-8').strip()) except subprocess.CalledProcessError: # Handle docs builds from tarball git_version = "v0.0.9999-local" version = git_version # The full version, including alpha/beta/rc tags. release = version
Source: https://github.com/lfit/releng-global-jjb/blob/master/docs/conf.py#L80-L93
Attachments
Issue Links
- relates to
-
DOCS-113 Find way to avoid need for docs/conf.yaml version maintenance per-project
-
- Closed
-
