docs: Python 3.12 compatibility (#1123)

* docs: Python 3.12 compatibility

* docs: make 3.10 backwards compatible

* docs: remove print

* docs: update changelog

* chore: replace flake8 for ruff

* downgrade minimum python version

* add back setuptools

* move setuptools as a dependency

Author: dgarcia360

.flake8

@@ -9,33 +9,26 @@ repos:
         args: ["build"]
         language: system
         pass_filenames: false
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.3
-    hooks:
-      - id: prettier
-
   - repo: https://github.com/rtts/djhtml
     rev: 3.0.6
     hooks:
       - id: djhtml
 
-  - repo: https://github.com/pycqa/flake8
-    rev: "6.1.0"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
     hooks:
-      - id: flake8
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace

.pre-commit-config.yaml

@@ -0,0 +1,2 @@
+line-length = 88
+exclude = ["sphinx_scylladb_theme/lexers/cql.py"]

.ruff.toml

@@ -5,15 +5,14 @@ version = "0.1.0"
 authors = ["ScyllaDB Documentation Contributors"]
 
 [tool.poetry.dependencies]
-python = "^3.9"
-pyyaml = "6.0.1"
-pygments = "2.15.1"
+python = "^3.10"
+pygments = "2.18.0"
 sphinx-scylladb-theme = "~1.6.1"
-myst-parser = "2.0.0"
-sphinx-autobuild = "2021.3.14"
-Sphinx = "7.2.6"
+myst-parser = "3.0.1"
+sphinx-autobuild = "2024.4.16"
+Sphinx = "7.3.7"
 sphinx-multiversion-scylla = "^0.3.1"
-sphinx-sitemap = "2.5.1"
+sphinx-sitemap = "2.6.0"
 redirects_cli ="~0.1.3"
 
 [build-system]

docs/_utils/pyproject_template.toml

@@ -5,15 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.7.3 - 25 Jun 2024
+
+### Updated
+
+- [#1123](https://github.com/scylladb/sphinx-scylladb-theme/pull/1123): Compatibility with Python 3.12.
+- [#1123](https://github.com/scylladb/sphinx-scylladb-theme/pull/1123): Replaced Flake8 with Ruff for faster code linting.
+
+### Removed
+
+- [#1123](https://github.com/scylladb/sphinx-scylladb-theme/pull/1123): Deprecate Prettier for code linting (pre-commit).
+
 ## 1.7.2 - 30 Apr 2024
 
 ### Added
 
-- Option to override the "Create an issue" label per project.
+- [#1093](https://github.com/scylladb/sphinx-scylladb-theme/pull/1093): Option to override the "Create an issue" label per project.
 
 ### Fixed
 
-- Right sidebar scroll highlighting.
+- [#1092](https://github.com/scylladb/sphinx-scylladb-theme/pull/1092): Right sidebar scroll highlighting.
 
 
 ## 1.7.1 - 12 Apr 2024

docs/source/upgrade/CHANGELOG.md

@@ -20,7 +20,7 @@
         "sphinx >= 2.1",
         "recommonmark == 0.7.1",
         "sphinx-markdown-tables == 0.0.17",
-        "myst-parser >= 2.0.0"
+        "myst-parser >= 2.0.0",
     ],
     packages=["sphinx_scylladb_markdown"],
 )

extensions/sphinx-scylladb-markdown/setup.py

@@ -1,49 +1,60 @@
 # -*- coding: utf-8 -*-
 import os
+
 from recommonmark.transform import AutoStructify
 
 __version__ = "0.1.3"
 
+
 class BaseParser:
     def __init__(self, app):
         self.app = app
 
     def setup(self):
         raise NotImplementedError
 
+
 class RecommonmarkParser(BaseParser):
     def setup(self):
         try:
-            self.app.setup_extension('recommonmark')
-            self.app.setup_extension('sphinx_markdown_tables')
+            self.app.setup_extension("recommonmark")
+            self.app.setup_extension("sphinx_markdown_tables")
 
-            self.app.add_config_value('recommonmark_config', {
-                'enable_eval_rst': True,
-                'enable_auto_toc_tree': False,
-            }, True)
+            self.app.add_config_value(
+                "recommonmark_config",
+                {
+                    "enable_eval_rst": True,
+                    "enable_auto_toc_tree": False,
+                },
+                True,
+            )
             self.app.add_transform(AutoStructify)
         except ImportError:
-            raise RuntimeError("recommonmark and sphinx_markdown_tables are not installed!")
+            raise RuntimeError(
+                "recommonmark and sphinx_markdown_tables are not installed!"
+            )
+
 
 class MystParser(BaseParser):
     def setup(self):
         try:
-            self.app.setup_extension('myst_parser')
+            self.app.setup_extension("myst_parser")
             self.app.config.myst_enable_extensions = ["colon_fence"]
             self.app.config.myst_heading_anchors = 6
 
         except ImportError:
             raise RuntimeError("myst-parser is not installed")
 
+
 def select_parser(app, config):
     if not config.scylladb_markdown_enable:
         return
 
-    current_version = os.environ.get('SPHINX_MULTIVERSION_NAME', 'stable')
+    current_version = os.environ.get("SPHINX_MULTIVERSION_NAME", "stable")
 
     config.source_suffix = {
-        '.rst': 'restructuredtext',
-        '.md': 'markdown',
+        ".rst": "restructuredtext",
+        ".md": "markdown",
     }
 
     if current_version in config.scylladb_markdown_recommonmark_versions:
@@ -53,10 +64,11 @@ def select_parser(app, config):
 
     parser.setup()
 
+
 def setup(app):
-    app.add_config_value('scylladb_markdown_enable', True, 'env')
-    app.add_config_value('scylladb_markdown_recommonmark_versions', [], 'env')
-    app.connect('config-inited', select_parser)
+    app.add_config_value("scylladb_markdown_enable", True, "env")
+    app.add_config_value("scylladb_markdown_recommonmark_versions", [], "env")
+    app.connect("config-inited", select_parser)
 
     return {
         "version": "0.1",