Better branch naming, added pygit2

Author: kanhereashwin

docs/source/conf.py

@@ -15,6 +15,7 @@
 import inspect
 import subprocess
 from os.path import relpath, dirname
+from pygit2 import Repository
 
 import gnss_lib_py
 
@@ -114,32 +115,38 @@
 
 # Function to find URLs for the source code on GitHub for built docs
 
-# The following code to find the head tag is taken from:
+# The original code to find the head tag was taken from:
 # https://gist.github.com/nlgranger/55ff2e7ff10c280731348a16d569cb73
-
-linkcode_revision = "main"
+# This code was modified to use branch names when the code differs from
+# main or a tag
+
+#Default to the main branch
+branch_name = "main"
+
+
+branch_name = Repository('.').head.shorthand
+# lock to commit number
+cmd = "git log -n1 --pretty=%H"
+head = subprocess.check_output(cmd.split()).strip().decode('utf-8')
+linkcode_revision = head
+# if we are on main's HEAD, use main as reference irrespective of
+# what branch you are on
+cmd = "git log --first-parent main -n1 --pretty=%H"
+main = subprocess.check_output(cmd.split()).strip().decode('utf-8')
+if head == main:
+    branch_name = "main"
+
+# if we have a tag, use tag as reference, irrespective of what branch
+# you are actually on
 try:
-    # lock to commit number
-    cmd = "git log -n1 --pretty=%H"
-    head = subprocess.check_output(cmd.split()).strip().decode('utf-8')
-    linkcode_revision = head
-
-    # if we are on main's HEAD, use main as reference
-    cmd = "git log --first-parent main -n1 --pretty=%H"
-    main = subprocess.check_output(cmd.split()).strip().decode('utf-8')
-    if head == main:
-        linkcode_revision = "main"
-
-    # if we have a tag, use tag as reference
     cmd = "git describe --exact-match --tags " + head
     tag = subprocess.check_output(cmd.split(" ")).strip().decode('utf-8')
-    linkcode_revision = tag
-
+    branch_name = tag
 except subprocess.CalledProcessError:
     pass
 
 linkcode_url = "https://github.com/Stanford-NavLab/gnss_lib_py/blob/" \
-               + linkcode_revision + "/{filepath}#L{linestart}-L{linestop}"
+               + branch_name + "/{filepath}#L{linestart}-L{linestop}"
 
 
 def linkcode_resolve(domain, info):

docs/source/requirements.txt

@@ -95,6 +95,7 @@ psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
 ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and os_name != "nt" or python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
 pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
+pygit2==1.12.2 ; python_version >= "3.8" and python_version < "3.12"
 pygments==2.15.1 ; python_version >= "3.8" and python_version < "3.12"
 pylint-exit==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
 pylint==2.17.4 ; python_version >= "3.8" and python_version < "3.12"

poetry.lock

@@ -35,6 +35,7 @@ matplotlib = "^3.5.1"
 plotly = "^5.8.0"
 kaleido = "0.2.1"
 requests = "^2.29.0"
+pygit2 = "^1.12.2"
 
 [tool.poetry.group.dev.dependencies]
 Sphinx = "^4.1.1"

pyproject.toml

@@ -88,6 +88,7 @@ psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
 ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and os_name != "nt" or python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
 pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
+pygit2==1.12.2 ; python_version >= "3.8" and python_version < "3.12"
 pygments==2.15.1 ; python_version >= "3.8" and python_version < "3.12"
 pylint==2.17.4 ; python_version >= "3.8" and python_version < "3.12"
 pynmea2==1.19.0 ; python_version >= "3.8" and python_version < "3.12"