VOL-4840 - Tracking ticket for release documentation.
conf.py
-------
o Define more external link macros to shorten URLs.
Misc
----
o Updated comments on version strings and misc items.
Change-Id: Ib4bc650e575bdc4b5c6a666c4147c8b93a41e797
diff --git a/conf.py b/conf.py
index 78b1d20..4a68580 100644
--- a/conf.py
+++ b/conf.py
@@ -12,8 +12,19 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
+##-------------------##
+##---] IMPORTS [---##
+##-------------------##
import os
+import sys
+from pathlib import Path
+if True:
+ pwd = Path(__file__).parent.as_posix()
+ sys.path.append(pwd)
+
+# -----------------------------------------------------------------------
+# -----------------------------------------------------------------------
def get_version():
with open("VERSION") as f:
return f.read().strip()
@@ -21,7 +32,7 @@
# -- Project information -----------------------------------------------------
project = u'VOLTHA Docs'
-copyright = u'2019-2022, VOLTHA Contributors & Open Networking Foundation'
+copyright = u'Copyright 2019-2023 Open Networking Foundation (ONF) and the ONF Contributors'
author = u'VOLTHA Contributors'
# The short X.Y version
@@ -270,9 +281,12 @@
# -- Options for extlinks extension ------------------------------------------
# ..seealso: https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
# 'vhc' : 'https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts',
+
extlinks=\
{
'vol-jira' : ('https://jira.opencord.org/projects/VOL/issues/%s', 'jira::%s'),
+ # macros for gerrit or github URL construction
+ 'repo' : ('https://github.com/opencord/%s', 'repo::%s'),
'vol-ger' : ('https://gerrit.opencord.org/plugins/gitiles/%s', 'gerrit::%s'),
'vol-git' : ('https://github.com/opencord/%s', 'git::%s'),
}