From bc727fd29a61da12a6ecd897798ce9873c8f8a96 Mon Sep 17 00:00:00 2001
From: Abrar Rahman Protyasha <abrar@openrobotics.org>
Date: Thu, 29 Jul 2021 17:21:19 -0400
Subject: [PATCH] Reorganized `SphinxBuilder` for markdown parsing

* Removed a stray TODO comment from an experimental idea for #22.
* Moved the `lexerMapping` changes to `exhale` arguments into the
  conditional `support_markdown` block, so that the appropriate Pygments
  lexer is only registered if support for markdown was enabled.
* Added longer description of the `support_markdown` option.

Signed-off-by: Abrar Rahman Protyasha <abrar@openrobotics.org>
---
 .../verbs/build/builders/sphinx_builder.py    | 28 +++++++++++--------
 1 file changed, 17 insertions(+), 11 deletions(-)

diff --git a/rosdoc2/verbs/build/builders/sphinx_builder.py b/rosdoc2/verbs/build/builders/sphinx_builder.py
index 78ed185..6dc7e10 100644
--- a/rosdoc2/verbs/build/builders/sphinx_builder.py
+++ b/rosdoc2/verbs/build/builders/sphinx_builder.py
@@ -87,14 +87,6 @@ def ensure_global(name, default):
         # TIP: if using the sphinx-bootstrap-theme, you need
         # "treeViewIsBootstrap": True,
         "exhaleExecutesDoxygen": False,
-        # Maps markdown files to the "md" lexer, and not the "markdown" lexer
-        # Pygments registers "md" as a valid markdown lexer, and not "markdown"
-        "lexerMapping": {{r".*\.(md|markdown)$": "md",}},
-        # This mapping will work when `exhale` supports `:doxygenpage:` directives
-        # Check https://github.com/svenevs/exhale/issues/111
-        # TODO(aprotyas): Uncomment the mapping below once the above issue is resolved.
-        # "customSpecificationsMapping": utils.makeCustomSpecificationsMapping(
-        #     lambda kind: [":project:", ":path:", ":content-only:"] if kind == "page" else []),
     }})
 
 if rosdoc2_settings.get('override_theme', True):
@@ -116,9 +108,19 @@ def ensure_global(name, default):
     print(f"[rosdoc2] adding markdown parser", file=sys.stderr)
     # The `myst_parser` is used specifically if there are markdown files
     # in the sphinx project
-    # TODO(aprotyas): Migrate files under the `include` tag in the project's Doxygen
-    # configuration into the Sphinx project tree used to run the Sphinx builder in.
     extensions.append('myst_parser')
+    # If markdown support is enabled, the appropriate Pygments lexer must
+    # be registered for `.md`/`.markdown` file suffixes
+    exhale_args.update({{
+        # Maps markdown files to the "md" lexer, and not the "markdown" lexer
+        # Pygments registers "md" as a valid markdown lexer, and not "markdown"
+        "lexerMapping": {{r".*\.(md|markdown)$": "md",}},
+        # This mapping will work when `exhale` supports `:doxygenpage:` directives
+        # Check https://github.com/svenevs/exhale/issues/111
+        # TODO(aprotyas): Uncomment the mapping below once the above issue is resolved.
+        # "customSpecificationsMapping": utils.makeCustomSpecificationsMapping(
+        #     lambda kind: [":project:", ":path:", ":content-only:"] if kind == "page" else []),
+    }})
 """
 
 default_conf_py_template = """\
@@ -237,7 +239,11 @@ def ensure_global(name, default):
     ## Sphinx conf.py file.
     # 'automatically_extend_intersphinx_mapping': True,
 
-    ## Support markdown
+    ## This setting, if True, will add the `myst_parser` as an extension to
+    ## `sphinx`, hence allowing support for markdown rendering. This will also
+    ## register the `md` Pygments lexer with `.md`/`.markdown` file suffixes, so
+    ## that `exhale` can perform appropriate markdown syntax highlighting for
+    ## program listing rst files.
     # 'support_markdown': True,
 }}
 """