Skip to content
Open
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
39 changes: 35 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,41 @@
copyright = f"2020-{date.today().year}, DeepModeling "
author = "DeepModeling"

# The short X.Y version
version = "0.0"
# The full version, including alpha/beta/rc tags
release = "0.0.0-rc"

def _get_release() -> str:
"""Return the SCM or installed-package version for documentation builds."""
try:
from setuptools_scm import get_version
except ImportError:
pass
else:
try:
return get_version(root="..", relative_to=__file__)
except LookupError:
# Installed source archives may not include Git metadata.
pass

try:
from importlib.metadata import PackageNotFoundError
from importlib.metadata import version as get_version
except ImportError:
try:
from importlib_metadata import PackageNotFoundError
from importlib_metadata import version as get_version
except ImportError:
return "0+unknown"

try:
return get_version("dargs")
except PackageNotFoundError:
# Keep source-tree docs usable when neither package metadata nor SCM
# tooling is available.
return "0+unknown"


# Sphinx displays the short X.Y value separately from the full release string.
release = _get_release()
version = ".".join(release.split("+", 1)[0].split(".")[:2])


# -- General configuration ---------------------------------------------------
Expand Down
Loading