From 1775006d094d898cf1e3efce7320c2acf609f82e Mon Sep 17 00:00:00 2001 From: Douglas Raillard Date: Thu, 13 Apr 2023 19:28:21 +0100 Subject: [PATCH 1/2] doc: Enable source link in documentation The [source] link with embedded sources was removed a long time ago since it cluttered the search results with matches in the source code. This has now been resolved, so re-enable it. --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index b57b4b5dd..574302ae7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -106,7 +106,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', - # 'sphinx.ext.viewcode', + 'sphinx.ext.viewcode', 'sphinx.ext.inheritance_diagram', 'sphinxcontrib.plantuml', 'nbsphinx', -- GitLab From e4399906da2276ffee2f21dd5f1f538ed6044e36 Mon Sep 17 00:00:00 2001 From: Douglas Raillard Date: Thu, 13 Apr 2023 19:35:03 +0100 Subject: [PATCH 2/2] doc: Use lisa.__version__ as version Use lisa.__version__ instead of some broken git invocation. --- doc/conf.py | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 574302ae7..c6c000a25 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -142,15 +142,7 @@ copyright = '2017, ARM-Software' # |version| and |release|, also used in various other places throughout the # built documents. # -try: - git_description = subprocess.check_output( - ['git', 'describe', '--tags', '--match=v??.??']) - version = re.match(r'v([0-9][0-9]\.[0-9][0-9]).*', git_description).group(1) -except Exception as e: - logging.info(f"Couldn't set project version from git: {e}") - version = lisa.__version__ - -version = str(version) +version = str(lisa.__version__) release = version # The language for content autogenerated by Sphinx. Refer to documentation -- GitLab