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

Easier way of obtaining version in docs/conf.py #77

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kloczek
Copy link

@kloczek kloczek commented Aug 28, 2023

Obtain module version directly from objgraph.version

Obtain module version directly from objgraph.__version__
Copy link
Owner

@mgedmin mgedmin left a comment

Choose a reason for hiding this comment

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

Yes, but why?

@@ -80,9 +58,9 @@ def get_short_version():
# built documents.
#
# The short X.Y version.
version = get_short_version()
version = objgraph.__version__
Copy link
Owner

Choose a reason for hiding this comment

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

I may be misunderstanding Sphinx here, but shouldn't this be truncated to two components? __version__ may also include a bugfix component X.Y.Z.

Copy link
Author

Choose a reason for hiding this comment

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

In documentation I think that should be included full version.

Copy link
Owner

Choose a reason for hiding this comment

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

Then why is there a separate release setting with the full version?

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

Successfully merging this pull request may close these issues.

None yet

2 participants