bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Do not fail when manually authored doc file is not tracked by git

Browse Source 
This fixes a bug where a newly created documentation file not yet
tracked by git would cause the documentation generation to fail.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-11-23 14:02:19 +01:00 committed by Anas Nashif
parent 12cefe1027
commit 0b39da6869
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/_extensions/zephyr/gh_utils.py
View File

@ -173,7 +173,8 @@ def git_info_filter(app: Sphinx, pagename) -> Optional[Tuple[str, str]]:
Returns:
Optional[Tuple[str, str]] -- Tuple with the date and SHA1 of the last commit made to the
page, or None if the page is not in the repo.
page, or None if the page is not in the repo (generated file, or manually authored file not
yet tracked by git).
"""
page_prefix = get_page_prefix(app, pagename)
@ -186,6 +187,15 @@ def git_info_filter(app: Sphinx, pagename) -> Optional[Tuple[str, str]]:
app.env.doc2path(pagename, False),
)
# Check if the file is tracked by git
try:
subprocess.check_output(
["git", "ls-files", "--error-unmatch", orig_path],
stderr=subprocess.STDOUT,
)
except subprocess.CalledProcessError:
return None
try:
date_and_sha1 = (
subprocess.check_output(
@ -212,7 +222,6 @@ def git_info_filter(app: Sphinx, pagename) -> Optional[Tuple[str, str]]:
except subprocess.CalledProcessError:
return None
def add_jinja_filter(app: Sphinx):
if app.builder.format != "html":
return