fix: display template path relative to the template root

Author: azmeuk

jinja_autodoc/autotemplate.py

@@ -68,6 +68,9 @@ def make_rst(self):
         )
         if env.config["jinja_template_path"]:
             for template_path in template_paths:
+                relative_template_path = os.path.relpath(
+                    template_path, env.config["jinja_template_path"]
+                )
                 raw_docstring = parse_jinja_comment(template_path)
                 if raw_docstring is None:
                     continue
@@ -76,7 +79,7 @@ def make_rst(self):
                 if docstring is None:
                     continue
 
-                yield from autotemplate_directive(template_path, docstring)
+                yield from autotemplate_directive(relative_template_path, docstring)
         yield ""
 
     def run(self) -> list[nodes.Node]:

tests/test_autotemplate_directive/test_file_filter.html

@@ -1,16 +1,16 @@
 <dl class="jinja template">
-  <dt class="sig sig-object jinja" id="template-tests-roots-test-autotemplate-templatedir-template1.in">
+  <dt class="sig sig-object jinja" id="template-templatedir-template1.in">
     <span class="sig-name descname">
       <span class="pre">
         TEMPLATE
       </span>
     </span>
     <span class="sig-name descname">
       <span class="pre">
-        tests/roots/test-autotemplate/templatedir/template1.in
+        templatedir/template1.in
       </span>
     </span>
-    <a class="headerlink" href="#template-tests-roots-test-autotemplate-templatedir-template1.in" title="Link to this definition">
+    <a class="headerlink" href="#template-templatedir-template1.in" title="Link to this definition">
       ¶
     </a>
   </dt>

tests/test_autotemplate_directive/test_jinja_directive_html.html

@@ -1,16 +1,16 @@
 <dl class="jinja template">
-  <dt class="sig sig-object jinja" id="template-tests-roots-test-autotemplate-sample_template.in">
+  <dt class="sig sig-object jinja" id="template-sample_template.in">
     <span class="sig-name descname">
       <span class="pre">
         TEMPLATE
       </span>
     </span>
     <span class="sig-name descname">
       <span class="pre">
-        tests/roots/test-autotemplate/sample_template.in
+        sample_template.in
       </span>
     </span>
-    <a class="headerlink" href="#template-tests-roots-test-autotemplate-sample_template.in" title="Link to this definition">
+    <a class="headerlink" href="#template-sample_template.in" title="Link to this definition">
       ¶
     </a>
   </dt>

tests/test_autotemplate_directive/test_several_comments.html

@@ -1,16 +1,16 @@
 <dl class="jinja template">
-  <dt class="sig sig-object jinja" id="template-tests-roots-test-autotemplate-multiple_comments_template.in">
+  <dt class="sig sig-object jinja" id="template-multiple_comments_template.in">
     <span class="sig-name descname">
       <span class="pre">
         TEMPLATE
       </span>
     </span>
     <span class="sig-name descname">
       <span class="pre">
-        tests/roots/test-autotemplate/multiple_comments_template.in
+        multiple_comments_template.in
       </span>
     </span>
-    <a class="headerlink" href="#template-tests-roots-test-autotemplate-multiple_comments_template.in" title="Link to this definition">
+    <a class="headerlink" href="#template-multiple_comments_template.in" title="Link to this definition">
       ¶
     </a>
   </dt>

tests/test_autotemplate_directive/test_templatedir.html

@@ -1,16 +1,16 @@
 <dl class="jinja template">
-  <dt class="sig sig-object jinja" id="template-tests-roots-test-autotemplate-templatedir-template1.in">
+  <dt class="sig sig-object jinja" id="template-templatedir-template1.in">
     <span class="sig-name descname">
       <span class="pre">
         TEMPLATE
       </span>
     </span>
     <span class="sig-name descname">
       <span class="pre">
-        tests/roots/test-autotemplate/templatedir/template1.in
+        templatedir/template1.in
       </span>
     </span>
-    <a class="headerlink" href="#template-tests-roots-test-autotemplate-templatedir-template1.in" title="Link to this definition">
+    <a class="headerlink" href="#template-templatedir-template1.in" title="Link to this definition">
       ¶
     </a>
   </dt>
@@ -46,18 +46,18 @@
 </dl>
 
 <dl class="jinja template">
-  <dt class="sig sig-object jinja" id="template-tests-roots-test-autotemplate-templatedir-template2.in">
+  <dt class="sig sig-object jinja" id="template-templatedir-template2.in">
     <span class="sig-name descname">
       <span class="pre">
         TEMPLATE
       </span>
     </span>
     <span class="sig-name descname">
       <span class="pre">
-        tests/roots/test-autotemplate/templatedir/template2.in
+        templatedir/template2.in
       </span>
     </span>
-    <a class="headerlink" href="#template-tests-roots-test-autotemplate-templatedir-template2.in" title="Link to this definition">
+    <a class="headerlink" href="#template-templatedir-template2.in" title="Link to this definition">
       ¶
     </a>
   </dt>