fix(docs): Support out-of-tree builds (#2312)

Searching up from the conf.py only works if it is inside the repository
and not for out-of-tree builds (because conf.py gets configured in the
build directory).
This commit is contained in:
Patrick Ziegler 2020-12-17 14:02:48 +01:00 committed by GitHub
parent cec463e830
commit 1bf89e8b76
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,23 +20,17 @@ from docutils.nodes import Node
from sphinx.domains.changeset import VersionChange from sphinx.domains.changeset import VersionChange
import packaging.version import packaging.version
def get_version(): def get_version(root_path):
""" """
Searches for the version.txt file and extracts the version from it Reads the polybar version from the version.txt at the root of the repo.
"""
path = Path(root_path) / "version.txt"
with open(path, "r") as f:
for line in f.readlines():
if not line.startswith("#"):
return packaging.version.parse(line)
Searches up the directory tree from the conf.py file because depending on the raise RuntimeError("No version found in {}".format(path))
build method, the conf.py file will be at a different location (because it is
configured by cmake)
"""
current_path = Path(__file__).parent
while current_path != current_path.parent:
candidate = current_path / "version.txt"
if candidate.exists():
with open(candidate, "r") as f:
for line in f.readlines():
if not line.startswith("#"):
return packaging.version.parse(line)
current_path = current_path.parent
@ -61,11 +55,6 @@ else:
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = version release = version
# The version from the version.txt file. Since we are not always first
# configured by cmake, we don't necessarily have access to the current version
# number
version_txt = get_version()
# Set path to documentation # Set path to documentation
if on_rtd: if on_rtd:
# On readthedocs conf.py is already in the doc folder # On readthedocs conf.py is already in the doc folder
@ -75,6 +64,11 @@ else:
# build folder. # build folder.
doc_path = '@doc_path@' doc_path = '@doc_path@'
# The version from the version.txt file. Since we are not always first
# configured by cmake, we don't necessarily have access to the current version
# number
version_txt = get_version(Path(doc_path).absolute().parent)
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.