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

Show Documentation Version #11

Merged
merged 6 commits into from
Oct 29, 2024
Merged

Conversation

gabryelreyes
Copy link
Contributor

@gabryelreyes gabryelreyes commented Oct 28, 2024

Results can be seen here:

  • A version is shown under the name of the documentation
  • Links have a marker on the end

image

Closes #10

@gabryelreyes gabryelreyes added the enhancement New feature or request label Oct 28, 2024
@gabryelreyes gabryelreyes self-assigned this Oct 28, 2024
@gabryelreyes gabryelreyes linked an issue Oct 28, 2024 that may be closed by this pull request
Copy link
Collaborator

@nhjschulz nhjschulz left a 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' ])

Copy link
Collaborator

@Karle3 Karle3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

discussed..

@gabryelreyes gabryelreyes merged commit e34e534 into release/v1.1.x Oct 29, 2024
2 checks passed
@gabryelreyes gabryelreyes deleted the feature/show_version branch October 29, 2024 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show some kind of version in the deployed gh-pages.
3 participants