[Bf-docboard-svn] bf-manual: [8036] branches/blender-2.93-release/blender_docs/tools_maintenance/blender_help_extract.py: Generate heading reference targets for command line headings

[Aaron Carlisle]

Revision: 8036
          https://developer.blender.org/rBM8036
Author:   Blendify
Date:     2021-05-17 20:30:54 +0200 (Mon, 17 May 2021)
Log Message:
-----------
Generate heading reference targets for command line headings

Also use relative path to Blender source tree in the command line example.

rBM8012

Modified Paths:
--------------
    branches/blender-2.93-release/blender_docs/tools_maintenance/blender_help_extract.py

Modified: branches/blender-2.93-release/blender_docs/tools_maintenance/blender_help_extract.py
===================================================================
--- branches/blender-2.93-release/blender_docs/tools_maintenance/blender_help_extract.py	2021-05-17 18:27:07 UTC (rev 8035)
+++ branches/blender-2.93-release/blender_docs/tools_maintenance/blender_help_extract.py	2021-05-17 18:30:54 UTC (rev 8036)
@@ -9,7 +9,7 @@
 # using primitive regex parsing.
 #
 # e.g:
-# python tools_maintenance/blender_help_extract.py /src/blender/source/creator/creator_args.c manual/advanced/command_line/arguments.rst
+# python tools_maintenance/blender_help_extract.py ../blender/source/creator/creator_args.c manual/advanced/command_line/arguments.rst
 
 
 def text_remove_comments(text):
@@ -226,9 +226,24 @@
                 # Run the C-style string format.
                 l = l[0] % l[1:]
             if l.lstrip() == l and l.strip("\n").endswith(":"):
-                # create rst heading
+                # Create RST heading & unique reference target.
                 l = l.strip(":\n")
-                l = "\n\n" + l + "\n" + len(l) * "=" + "\n\n"
+                l = (
+                    "\n"
+                    "\n"
+                    ".. _command-line-args-%s:\n"
+                    "\n"
+                    "%s\n"
+                    "%s\n"
+                    "\n"
+                ) % (
+                    # Create reference so each heading can be linked to.
+                    "".join([(c if c.isalpha() else "-") for c in l.lower()]),
+                    # The heading.
+                    l,
+                    # Heading underline.
+                    len(l) * "=",
+                )
                 ind_re = None
             else:
                 # unindent to the previous min indent