doc: consistently overwrite MicroCloud links

- Copies the MicroCloud `overwrite_links.js` file into the cloned LXD,
  MicroCeph, and MicroOVN repos as `overwrite_microcloud_links.js`, so
  that the JavaScript loads across the integrated docs
- Prefixes functions and variables in the MicroCloud
  `overwrite_links.js` file with `microcloud_` in order to prevent
  conflicts with the equivalents in the LXD, MicroCeph, and MicroOVN
  `overwrite_links.js` files.
- Reconfigures the Makefile to append `add_config.py` to the end of the
  MicroOVN `conf.py` so that the addition of
  `overwrite_microcloud_links.js` to `html_js_files` applies to
  MicroOVN.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
(cherry picked from commit fde8f1a)

Author: elijahgreenstein

doc/.sphinx/_integration/add_config.py

@@ -12,16 +12,25 @@
 if project == "LXD":
     html_baseurl = "https://canonical.com/lxd/docs/v5.21/"
     html_css_files = globals().get('html_css_files', []) + ['override-header.css']
+    html_js_files = globals().get('html_js_files', []) + ['js/overwrite_microcloud_links.js']
     tags.add('integrated')
 elif project == "MicroCeph":
     html_baseurl = "https://documentation.ubuntu.com/microceph/v19.2.0-squid/"
     # Override default header styles
     html_static_path = globals().get('html_static_path', []) + ["_static"]
-    html_css_files = globals().get('html_css_files', []) + ['override-header.css', 'https://assets.ubuntu.com/v1/d86746ef-cookie_banner.css']
-    html_js_files = globals().get('html_js_files', []) + ['https://assets.ubuntu.com/v1/287a5e8f-bundle.js']
+    html_css_files = globals().get('html_css_files', []) + [
+        'override-header.css',
+        'https://assets.ubuntu.com/v1/d86746ef-cookie_banner.css',
+    ]
+    html_js_files = globals().get('html_js_files', []) + [
+        'https://assets.ubuntu.com/v1/287a5e8f-bundle.js',
+        'overwrite_microcloud_links.js',  # Add js to overwrite MicroCloud links
+    ]
     # Add "integrated" to the list of custom tags
     tags.add('integrated')
 elif project == "MicroOVN":
     html_baseurl = "https://ubuntu.com/docs/microovn/24.03/"
-    custom_tags.append('integrated')
-
+    tags.add('integrated')
+    html_static_path = globals().get('html_static_path', []) + ["_static"]
+    # Add js to overwrite MicroCloud links
+    html_js_files = globals().get('html_js_files', []) + ['overwrite_microcloud_links.js']

doc/Makefile

@@ -117,11 +117,18 @@ integrate:
 	# Add information about where to find the tags/docs to the doc sets
 	cat .sphinx/_integration/add_config.py >> integration/lxd/doc/conf.py
 	cat .sphinx/_integration/add_config.py >> integration/microceph/docs/conf.py
-	cat .sphinx/_integration/add_config.py >> integration/microovn/docs/custom_conf.py
+	cat .sphinx/_integration/add_config.py >> integration/microovn/docs/conf.py
 
 	# Override the MicroOVN tag with the circle of friends one (for consistency)
 	cp .sphinx/_integration/tag.png integration/microovn/docs/.sphinx/_static/microovn.png
 
+	# Copy MicroCloud `overwrite_links.js` to all repos
+	cp _static/js/overwrite_links.js integration/lxd/doc/_static/js/overwrite_microcloud_links.js
+	mkdir -p integration/microceph/docs/_static
+	cp _static/js/overwrite_links.js integration/microceph/docs/_static/overwrite_microcloud_links.js
+	mkdir -p integration/microovn/docs/_static
+	cp _static/js/overwrite_links.js integration/microovn/docs/_static/overwrite_microcloud_links.js
+
 # `html` builds the integrated docs.
 html: integrate install
 	mkdir -p $(current_dir)/_build

doc/_static/js/overwrite_links.js

@@ -1,26 +1,26 @@
  // Replace oldDomain with newDomain
- const oldDomain = 'canonical-microcloud-documentation.readthedocs-hosted.com';
- const newDomain = 'canonical.com/microcloud/docs';
+ const microcloud_oldDomain = 'canonical-microcloud-documentation.readthedocs-hosted.com';
+ const microcloud_newDomain = 'canonical.com/microcloud/docs';
 
- function escapeRegExp(value) {
+ function microcloud_escapeRegExp(value) {
      return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
  }
 
- function overwriteMatchingAnchorUrls(container) {
+ function microcloud_overwriteMatchingAnchorUrls(container) {
      if (!container) return;
 
      const anchors = container.querySelectorAll('a[href], link[href]');
-     const oldDomainRegex = new RegExp(escapeRegExp(oldDomain), 'g');
+     const oldDomainRegex = new RegExp(microcloud_escapeRegExp(microcloud_oldDomain), 'g');
 
      anchors.forEach(anchor => {
-         anchor.href = anchor.href.replace(oldDomainRegex, newDomain);
+         anchor.href = anchor.href.replace(oldDomainRegex, microcloud_newDomain);
      });
  }
 
- overwriteMatchingAnchorUrls(document.querySelector('header'));
+ microcloud_overwriteMatchingAnchorUrls(document.querySelector('header'));
 
  // Use a MutationObserver to wait for the RTD flyout element to appear in the DOM
- const observer = new MutationObserver(function(mutations, obs) {
+ const microcloud_observer = new MutationObserver(function(mutations, obs) {
 
      const rtdFlyout = document.querySelector('readthedocs-flyout');
      if (!rtdFlyout) return;
@@ -31,8 +31,8 @@
          const shadowRoot = rtdFlyout.shadowRoot;
          if (!shadowRoot) return;
 
-         overwriteMatchingAnchorUrls(shadowRoot);
+         microcloud_overwriteMatchingAnchorUrls(shadowRoot);
      });
  });
 
- observer.observe(document.body, { childList: true, subtree: true });
+ microcloud_observer.observe(document.body, { childList: true, subtree: true });