Skip to content

doc build take version from git when package not installed #48

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

Merged
merged 1 commit into from
Feb 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,15 @@

import datetime

import virtualenvwrapper.version
# Try to import the version from our package, but if that fails
# because of the way the RTD build works fall back to at least using
# the git tag information.
try:
from virtualenvwrapper.version import version
except ImportError:
import subprocess
p = subprocess.run(['git', 'describe'], stdout=subprocess.PIPE)
version = p.stdout.decode('utf-8').strip()

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -52,7 +60,7 @@
# built documents.
#
# The short X.Y version.
version = virtualenvwrapper.version.version
# version = "SEE IMPORTS ABOVE"
# The full version, including alpha/beta/rc tags.
release = version

Expand Down