feat: rtd integration config changes

_static/js/url_overwrite.js

@@ -0,0 +1,51 @@
+// overwrite links.js
+
+// Replace oldDomain with newDomain
+const oldDomain = 'canonical-migration-anbox-docs.readthedocs-hosted.com';
+const newDomain = 'canonical.com/anbox-cloud/docs';
+
+// // Logging for debugging purposes
+// console.stdlog = console.log.bind(console);
+// console.logs = [];
+
+// console.log = function() {
+//     // 1. Store the arguments in the logs array
+//     console.logs.push(Array.from(arguments));
+
+//     // 2. Call the original console.log to still output to the browser console
+//     console.stdlog.apply(console, arguments);
+// };
+
+// Set up a mutation observer to monitor changes in the DOM
+// RTD flyout is created dynamically, so we need to wait for it to appear
+const targetNode = document.body;
+const config = { childList: true, subtree: true };
+
+// Callback function to execute when mutation is observed
+function waitForElement(element, callback){
+    var foo = setInterval(function(){
+        // console.log(`Waiting for element: ${element}...`)
+        if(document.querySelector(element)){
+            clearInterval(foo);
+            // console.log(`Element found: ${element}.`)
+            callback();
+        }
+    }, 100);
+}
+
+// Start observing the target node (rtd-flyout)
+// execute the overwrite when the element is loaded 
+waitForElement("readthedocs-flyout", function(){
+    // console.log(`Triggering URL rewrite`)
+    const rtdFlyout = document.querySelector('readthedocs-flyout');
+    rtdFlyout.addEventListener('click', function(e) {
+        // Access the shadow DOM of the 'readthedocs-flyout' element
+        const shadowRoot = rtdFlyout.shadowRoot;
+        const anchors = shadowRoot.querySelectorAll('a');
+        anchors.forEach(anchor => {
+            // console.log(`Checking URL for replacement: ${anchor.href}`);
+            anchor.href = anchor.href.replace(new RegExp(oldDomain, 'g'), newDomain);
+            // console.log(`URL now: ${anchor.href}`);
+        });
+    });
+});

conf.py

@@ -71,7 +71,7 @@
 # NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph
 #       and is used by social media platforms; see https://ogp.me/
 
-ogp_site_url = "https://documentation.ubuntu.com/anbox-cloud/"
+ogp_site_url = "https://canonical.com/anbox-cloud/docs/"
 
 
 # Preview name of the documentation website
@@ -170,7 +170,7 @@
 # If your documentation is hosted on https://docs.ubuntu.com/,
 #       uncomment and update as needed.
 
-slug = 'anbox-cloud'
+slug = 'anbox-cloud/docs'
 
 #######################
 # Sitemap configuration: https://sphinx-sitemap.readthedocs.io/
@@ -377,7 +377,8 @@
 # Adds custom JavaScript files, located under 'html_static_path'
 
 html_js_files = [
-    "js/cookie-banner-bundle.js"
+    "js/cookie-banner-bundle.js",
+    "js/url_overwrite.js",
 ]