-
Notifications
You must be signed in to change notification settings - Fork 0
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
Show Documentation Version #11
Conversation
Added missing version variable for Sphinx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we use something more clever than a hardcoded string ?
It is a pain to manual update or forget it sometimes.
How about output of "git describe HEAD" ?
It gives the nearest label + distance like
$ git describe HEAD
v1.0.2-2-g7362281
Called from CI with a labled branch should then give the label string as version.
To embedd this in conf.py do
import subprocess
version= subprocess.check_output([ 'git', 'describe', 'HEAD' ])
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
discussed..
Results can be seen here:
Closes #10