📝 docs: read the docs

Signed-off-by: Zerohertz <ohg3417@gmail.com>

Author: Zerohertz

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+  jobs:
+    pre_build:
+      - python -m pip install --upgrade pip
+      - pip install .'[all]'
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: sphinx/source/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements/requirements-docs.txt

README.md

@@ -15,7 +15,7 @@
     <a href="https://github.com/Zerohertz/zerohertzLib">
         <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=white"/>
     </a>
-    <a href="https://zerohertz.github.io/zerohertzLib/">
+    <a href="https://zerohertzlib.readthedocs.io/">
         <img src="https://img.shields.io/badge/Sphinx-Docs-000000?style=for-the-badge&logo=Sphinx&logoColor=white"/>
     </a>
     </br>

sphinx/source/conf.py

@@ -60,7 +60,7 @@
 autodoc_typehints = "none"
 todo_include_todos = True
 gtagjs_ids = [
-    "G-ZCW0CR8M8X",
+    "G-J25S5BY1L7",
 ]
 # add_module_names = False
 
@@ -88,7 +88,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_theme = "furo"
-html_baseurl = "https://zerohertz.github.io/zerohertzLib/"
+html_baseurl = os.getenv(
+    "READTHEDOCS_CANONICAL_URL", "https://zerohertzlib.readthedocs.io/"
+)
 html_static_path = ["_static"]
 html_logo = "_static/zerohertzLib-tp-red.png"
 
@@ -131,7 +133,9 @@
     ],
 }
 
-ogp_site_url = "https://zerohertz.github.io/zerohertzLib/"
+ogp_site_url = os.getenv(
+    "READTHEDOCS_CANONICAL_URL", "https://zerohertzlib.readthedocs.io/"
+)
 ogp_description_length = 200
 ogp_site_name = f"Zerohertz's Library {release} Documents"
 ogp_image = "_static/zerohertzLib-black-red-og.png"
@@ -157,7 +161,7 @@ def linkcode_resolve(domain, info):
             obj = getattr(obj, part)
         obj_filename = inspect.getsourcefile(obj)
         obj_line = inspect.getsourcelines(obj)[1]
-    except Exception as error:
+    except Exception:
         return None
     rel_fn = relpath(obj_filename, start=dirname(module.__file__))
     return f"https://github.com/zerohertz/zerohertzLib/blob/master/{info['module'].replace('.', '/')}/{rel_fn}#L{obj_line}"
@@ -168,7 +172,7 @@ def linkcode_resolve(domain, info):
 # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
 # html_theme_options = {
-#     "analytics_id": "G-ZCW0CR8M8X",
+#     "analytics_id": "G-J25S5BY1L7",
 #     "analytics_anonymize_ip": False,
 #     "logo_only": True,
 #     "style_nav_header_background": "#000000",

sphinx/source/index.md

@@ -20,7 +20,7 @@
     <a href="https://github.com/Zerohertz/zerohertzLib">
         <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=white"/>
     </a>
-    <a href="https://zerohertz.github.io/zerohertzLib/">
+    <a href="https://zerohertzlib.readthedocs.io/">
         <img src="https://img.shields.io/badge/Sphinx-Docs-000000?style=for-the-badge&logo=Sphinx&logoColor=white"/>
     </a>
     </br>