Initial commit of working docs versioning.

Author: fkdosilovic

.github/workflows/docs.yml

@@ -18,6 +18,8 @@ jobs:
 
     - name: Build HTML
       uses: ammaraskar/sphinx-action@7.0.0
+      with:
+        build-command: "sphinx-multiversion source build/html"
 
     - name: Upload artifacts
       uses: actions/upload-artifact@v4
@@ -30,4 +32,4 @@ jobs:
       if: github.ref == 'refs/heads/master'
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/build/html
+        publish_dir: docs/build/html/master

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinxawesome-theme==5.3.2
 sphinx-autodoc-typehints==2.3.0
+sphinx-multiversion==0.2.4

docs/source/_templates/versioning.html

@@ -0,0 +1,8 @@
+{% if versions %}
+<h3>{{ _('Versions') }}</h3>
+<ul>
+    {%- for item in versions %}
+    <li><a href="{{ item.url }}">{{ item.name }}</a></li>
+    {%- endfor %}
+</ul>
+{% endif %}

docs/source/conf.py

@@ -13,7 +13,7 @@
 project = "Judge0 Python SDK"
 copyright = "2024, Judge0"
 author = "Judge0"
-release = "0.1"
+release = ""
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -23,19 +23,24 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
     "sphinx_autodoc_typehints",
+    "sphinx_multiversion",
 ]
 
 templates_path = ["_templates"]
 exclude_patterns = []
 
-
-# add_module_names = False
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinxawesome_theme"
 html_show_sphinx = False
+html_sidebars = {
+    "**": [
+        "sidebar_main_nav_links.html",
+        "sidebar_toc.html",
+        "versioning.html",
+    ],
+}
 
 sys.path.insert(0, os.path.abspath("../../src/"))  # Adjust as needed
 
@@ -50,3 +55,17 @@
 autodoc_mock_imports = ["requests", "pydantic"]
 
 napoleon_google_docstring = False
+
+# Whitelist pattern for tags (set to None to ignore all tags)
+smv_tag_whitelist = r"^.*$"
+# Whitelist pattern for branches (set to None to ignore all branches)
+smv_branch_whitelist = r"^master$"
+# Whitelist pattern for remotes (set to None to use local branches only)
+smv_remote_whitelist = None
+# Pattern for released versions
+smv_released_pattern = ""  # r"^tags/.*$"
+# Format for versioned output directories inside the build directory
+smv_outputdir_format = "{ref.name}"
+# Determines whether remote or local git branches/tags are preferred if their
+# output dirs conflict
+smv_prefer_remote_refs = False

docs/source/index.rst

@@ -15,7 +15,7 @@ You can run minimal Hello World example in three easy steps:
 
 2. Create a minimal script:
 
-.. code-block:: Python
+.. code-block:: python
 
     import judge0