fix: redirection to api reference

Fix javadoc redirect

Fix

(cherry picked from commit a9fcffb)

Author: dgarcia360

docs/Makefile

@@ -18,9 +18,6 @@ ifeq ($(OS),Windows_NT)
     POETRY = $(APPDATA)\Python\Scripts\poetry
 endif
 
-define javadoc
-    cd .. && ./docs/_utils/javadoc.sh
-endef
 
 .PHONY: all
 all: dirhtml
@@ -55,10 +52,9 @@ dirhtml: setup
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
-.PHONY: singlehtml
-singlehtml: setup
-	@$(javadoc)
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+.PHONY: javadoc
+javadoc: setup
+	cd .. && ./docs/_utils/javadoc.sh
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
@@ -110,4 +106,4 @@ test: setup
 
 .PHONY: linkcheck
 linkcheck: setup
-	$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
+	$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck

docs/pyproject.toml

@@ -9,12 +9,14 @@ python = "^3.7"
 pyyaml = "6.0"
 pygments = "2.2.0"
 recommonmark = "0.7.1"
-redirects_cli ="~0.1.2"
+redirects_cli ="~0.1.3"
 sphinx-scylladb-theme = "~1.3.1"
 sphinx-sitemap = "2.1.0"
 sphinx-autobuild = "2021.3.14"
 Sphinx = "4.3.2"
 sphinx-multiversion-scylla = "~0.2.12"
+setuptools = "^65.6.3"
+wheel = "^0.38.4"
 
 [build-system]
 requires = ["poetry>=0.12"]

docs/source/conf.py

@@ -9,7 +9,7 @@
 from recommonmark.transform import AutoStructify
 from recommonmark.parser import CommonMarkParser, splitext, urlparse
 from sphinx_scylladb_theme.utils import multiversion_regex_builder
-
+from redirects_cli import cli as redirects_cli
 
 # -- General configuration ------------------------------------------------
 
@@ -46,50 +46,6 @@
 }
 autosectionlabel_prefix_document = True
 
-class CustomCommonMarkParser(CommonMarkParser):
-    
-    def visit_document(self, node):
-        pass
-    
-    def visit_link(self, mdnode):
-        # Override to avoid checking if relative links exists
-        ref_node = nodes.reference()
-        destination = mdnode.destination
-        _, ext = splitext(destination)
-
-        url_check = urlparse(destination)
-        scheme_known = bool(url_check.scheme)
-
-        if not scheme_known and ext.replace('.', '') in self.supported:
-            destination = destination.replace(ext, '')
-        ref_node['refuri'] = destination
-        ref_node.line = self._get_line(mdnode)
-        if mdnode.title:
-            ref_node['title'] = mdnode.title
-        next_node = ref_node
-
-        self.current_node.append(next_node)
-        self.current_node = ref_node
-
-def replace_relative_links(app, docname, source):
-    result = source[0]
-    for key in app.config.replacements:
-        result = re.sub(key, app.config.replacements[key], result)
-    source[0] = result
-
-def setup(app):
-    app.add_source_parser(CustomCommonMarkParser)
-    app.add_config_value('recommonmark_config', {
-        'enable_eval_rst': True,
-        'enable_auto_toc_tree': False,
-    }, True)
-    app.add_transform(AutoStructify)
-
-    # Replace DataStax links
-    replacements = {r'https://docs.datastax.com/en/drivers/java\/(.*?)\/': "https://java-driver.docs.scylladb.com/stable/api/"}
-    app.add_config_value('replacements', replacements, True)
-    app.connect('source-read', replace_relative_links)
-
 # The master toctree document.
 master_doc = 'contents'
 
@@ -178,3 +134,61 @@ def setup(app):
 
 # Dictionary of values to pass into the template engine’s context for all pages
 html_context = {'html_baseurl': html_baseurl}
+
+# -- Initialize Sphinx ----------------------------------------------
+
+class CustomCommonMarkParser(CommonMarkParser):
+    
+    def visit_document(self, node):
+        pass
+    
+    def visit_link(self, mdnode):
+        # Override MarkDownParser to avoid checking if relative links exists
+        ref_node = nodes.reference()
+        destination = mdnode.destination
+        _, ext = splitext(destination)
+
+        url_check = urlparse(destination)
+        scheme_known = bool(url_check.scheme)
+
+        if not scheme_known and ext.replace('.', '') in self.supported:
+            destination = destination.replace(ext, '')
+        ref_node['refuri'] = destination
+        ref_node.line = self._get_line(mdnode)
+        if mdnode.title:
+            ref_node['title'] = mdnode.title
+        next_node = ref_node
+
+        self.current_node.append(next_node)
+        self.current_node = ref_node
+
+def replace_relative_links(app, docname, source):
+    result = source[0]
+    for key in app.config.replacements:
+        result = re.sub(key, app.config.replacements[key], result)
+    source[0] = result
+
+def build_finished(app, exception):
+    version_name = os.getenv("SPHINX_MULTIVERSION_NAME", "")
+    version_name = "/" + version_name if version_name else ""
+    redirect_to = version_name +'/api/index.html'
+    out_file = app.outdir +'/api.html'
+    redirects_cli.create(redirect_to=redirect_to,out_file=out_file)
+
+def setup(app):
+    # Setup Markdown parser
+    app.add_source_parser(CustomCommonMarkParser)
+    app.add_config_value('recommonmark_config', {
+        'enable_eval_rst': True,
+        'enable_auto_toc_tree': False,
+    }, True)
+    app.add_transform(AutoStructify)
+
+    # Replace DataStax links
+    current_slug = os.getenv("SPHINX_MULTIVERSION_NAME", "stable")
+    replacements = {r'docs.datastax.com/en/drivers/java\/(.*?)\/': "java-driver.docs.scylladb.com/" + current_slug + "/api/"}
+    app.add_config_value('replacements', replacements, True)
+    app.connect('source-read', replace_relative_links)
+
+    # Create redirect to JavaDoc API
+    app.connect('build-finished', build_finished)