Fix github link in setting docs

The "filename" value returned by a static search is relative to the AnnotationConfig.source_path attribute. As a consequence, when we used the sphinx extension to document settings with `:folder_path: lms/envs/common.py` this resulted in incorrect links, such as: https://github.com/edx/edx-platform/blob/97e9fee92ed2c553e6a669f8ffba9151b122129d/common.py#L57 Compare to the correct link: https://github.com/edx/edx-platform/blob/97e9fee92ed2c553e6a669f8ffba9151b122129d/lms/envs/common.py#L57
openedx · Nov 9, 2020 · 32370e1 · 32370e1
1 parent 9b4702c
commit 32370e1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -11,6 +11,12 @@ Change Log
 
 .. There should always be an "Unreleased" section for changes pending release.
 
+[0.10.1] - 2020-11-09
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Fix Github links generated by the sphinx extension for settings.
+
+
 [0.10.0] - 2020-10-12
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/code_annotations/__init__.py b/code_annotations/__init__.py
@@ -2,4 +2,4 @@
 Extensible tools for parsing annotations in codebases.
 """
 
-__version__ = '0.10.0'
+__version__ = '0.10.1'
diff --git a/code_annotations/contrib/sphinx/extensions/settings.py b/code_annotations/contrib/sphinx/extensions/settings.py
@@ -72,12 +72,15 @@ def iter_nodes(self):
         """
         Iterate on the docutils nodes generated by this directive.
         """
-        source_path = os.path.join(
-            self.env.config.settings_source_path, self.options.get("folder_path", "")
-        )
+        folder_path = self.options.get("folder_path", "")
+        source_path = os.path.join(self.env.config.settings_source_path, folder_path)
         settings = find_settings(source_path)
+        # folder_path can point to a file or directory
+        root_folder = folder_path if os.path.isdir(source_path) else os.path.dirname(folder_path)
         for setting_name in sorted(settings):
             setting = settings[setting_name]
+            # setting["filename"] is relative to the root_path
+            setting_filename = os.path.join(root_folder, setting["filename"])
             setting_default_value = setting.get(".. setting_default:", "Not defined")
             setting_default_node = nodes.literal(
                 text=quote_value(setting_default_value)
@@ -95,7 +98,7 @@ def iter_nodes(self):
                     refuri="{}/blob/{}/{}#L{}".format(
                         self.env.config.settings_repo_url,
                         self.env.config.settings_repo_version,
-                        setting["filename"],
+                        setting_filename,
                         setting["line_number"],
                     ),
                 ),