Skip to content
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

populate sphinx "release" from git describe #1

Open
monkeypants opened this issue Apr 24, 2013 · 0 comments
Open

populate sphinx "release" from git describe #1

monkeypants opened this issue Apr 24, 2013 · 0 comments

Comments

@monkeypants
Copy link
Contributor

the rendered documentation includes a "release" version code. Currently, it's fixed at a hardcoded value from conf.py.

It would be nice if it was a semantic version tag (see http://semver.org/). It would be nice if it was dynamically generated, i.e. automagically up to date. It would be nice if it was driven from git tags.

The solution has something to do with "git describe", tagging major and minor numbers manually, and allowing git to magically increment the patch number. The solution would also involve some code in the conf.py, and maybe adding some sort of git python package in requirements.txt

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

No branches or pull requests

1 participant