new version

Author: Jannis-Mittenzwei

doc/conf.py

@@ -79,4 +79,9 @@
     "accent_color": "grass",
 }
 # -- Configure link checking behavior  ----------------------------------------
-linkcheck_rate_limit_timeout = 15
+linkcheck_rate_limit_timeout = 20
+linkcheck_timeout = 10
+linkcheck_anchors = False
+linkcheck_ignore = [
+    "https://github.com/exasol/python-toolbox/issues/new?assignees=&labels=documentation&projects=&template=documentation.md&title=%F0%9F%93%9A+%3CInsert+Title%3E"
+]

doc/developer_guide/modules/sphinx/sphinx.rst

@@ -4,7 +4,7 @@ sphinx
 sphinx-multiversion
 +++++++++++++++++++
 
-The `sphinx-multiversion` extension is a modified copy of `Holzhaus/sphinx-multiversion <https://github.com/Holzhaus/sphinx-multiversion>`_. This copy was taken from version :code:`0.24.0`.
+The `sphinx-multiversion` extension is a modified copy of `Holzhaus/sphinx-multiversion <https://github.com/sphinx-contrib/multiversion>`_. This copy was taken from version :code:`0.24.0`.
 
 It has been adjusted with minor code changes and modified defaults to work seamlessly with Exasol integration projects, which often require a specific project structure and layout. Additionally, it is designed to be used with an HTML theme that supports displaying and selecting multiple versions if the `versions` variable is set in the HTML context of sphinx. As of this writing, the theme used in conjunction with this modified version of `sphinx-multiversion` is `SHIBUYA <https://github.com/lepture/shibuya>`_, version :code:`2024.10.15`.
 

doc/styleguide/guides/idioms/idioms.rst

@@ -37,5 +37,5 @@ where we picked it up from, rather than the "original" source.
 
 
 .. _Raymond Hettinger: https://github.com/rhettinger
-.. _Transform Code into Beautiful, Idiomatic Python: https://www.youtube.com/watch?v=OSGv2VnC0go>
+.. _Transform Code into Beautiful, Idiomatic Python: https://www.youtube.com/watch?v=OSGv2VnC0go
 .. _Transform Python Slides: https://speakerdeck.com/pyconslides/transforming-code-into-beautiful-idiomatic-python-by-raymond-hettinger-1

doc/styleguide/guides/style.rst

@@ -54,10 +54,10 @@ _____
 .. _Google Styleguide: https://google.github.io/styleguide/pyguide.html
 .. _PEP 8: https://peps.python.org/pep-0008/
 .. _Python Idioms: https://gist.github.com/0x4D31/f0b633548d8e0cfb66ee3bea6a0deff9
-.. _Python Like You Mean It: http://www.pythonlikeyoumeanit.com/module_2.html>
+.. _Python Like You Mean It: http://www.pythonlikeyoumeanit.com/module_2.html
 .. _Python Programming Idioms: https://en.wikibooks.org/wiki/Python_Programming/Idioms
 
-.. _Transform Code into Beautiful, Idiomatic Python: https://www.youtube.com/watch?v=OSGv2VnC0go>
+.. _Transform Code into Beautiful, Idiomatic Python: https://www.youtube.com/watch?v=OSGv2VnC0go
 .. _Transform Python Slides: https://speakerdeck.com/pyconslides/transforming-code-into-beautiful-idiomatic-python-by-raymond-hettinger-1
 .. _Stop Writing Classes: https://www.youtube.com/watch?v=o9pEzgHorH0
 .. _Refactoring Python: https://www.youtube.com/watch?v=D_6ybDcU5gc

doc/user_guide/features.rst

@@ -13,7 +13,7 @@ Nox
 ---
 
 The most central tool when interacting with the toolbox is :code:`nox`, which is the task runner used across all of Exasol's Python-based projects.
-The toolbox itself provides various standard tasks and a plugin mechanism to extend these tasks if needed. For more information regarding nox, please visit the `nox homepage <http://nox.thea.codes/en/stable/>`_.
+The toolbox itself provides various standard tasks and a plugin mechanism to extend these tasks if needed. For more information regarding nox, please visit the `nox homepage <https://nox.thea.codes/en/stable/>`_.
 
 Central files in regards to nox and the toolbox are:
 

exasol/toolbox/nox/_documentation.py

@@ -51,31 +51,6 @@ def _build_multiversion_docs(session: nox.Session, config: Config) -> None:
     session.run("touch", f"{DOCS_OUTPUT_DIR}/.nojekyll")
 
 
-def _check_failed_links(results: list[str]):
-    errors = []
-    for line, result in enumerate(results):
-        if result.startswith("{") and "}" in result:
-            data = json.loads(result)
-            if not (data["status"] == "working") or (data["status"] == "ignored"):
-                match = re.search(r"https?://[^\s\"\'<>]+", data["uri"])
-                if match:
-                    try:
-                        request = requests.get(match.group(), timeout=15)
-                        if request.status_code == 200:
-                            data["status"] = "working"
-                            data["code"] = request.status_code
-                            if request.history:
-                                data["info"] = (
-                                    f'redirected: [{", ".join(step.url for step in request.history)}, {request.url}]'
-                                )
-                        results[line] = json.dumps(data)
-                    except requests.exceptions.Timeout:
-                        pass
-                if (data["status"] == "broken") or data["status"] == "timeout":
-                    errors.append(result)
-    return results, errors
-
-
 def _git_diff_changes_main() -> int:
     """
     Check if doc/changes is changed and return the exit code of command git diff.
@@ -170,11 +145,7 @@ def docs_links_check(session: Session) -> None:
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     parser.add_argument(
-        "-o",
-        "--output",
-        type=Path,
-        help="path to output file",
-        default="",
+        "-o", "--output", type=Path, help="path to output file", default=None
     )
     args = parser.parse_args(session.posargs)
     with tempfile.TemporaryDirectory() as path:
@@ -188,22 +159,22 @@ def docs_links_check(session: Session) -> None:
                 tmpdir,
             ],
         )
+        print(sp.returncode)
         if sp.returncode >= 2:
             print(sp.stderr)
             session.error(2)
-        output = tmpdir / "output.json"
-        out = output.read_text().split("\n")
-        results, errors = _check_failed_links(out)
-        if hasattr(args, "output"):
-            outputfile = Path(args.output) / "link-check-output.json"
-            if not outputfile.exists():
-                outputfile.parent.mkdir(parents=True, exist_ok=True)
-                outputfile.touch()
-            outputfile.write_text("\n".join(result for result in results))
-            print(f"file generated at path: {outputfile.resolve()}")
-        if errors:
-            print("Error" + "s" if len(errors) > 1 else "")
-            print("\n".join(error for error in errors))
+        if args.output:
+            print([hasattr(args, "output")])
+            print("warum gehst du hir rein")
+            result_json = tmpdir / "output.json"
+            dst = Path(args.output) / "link-check-output.json"
+            shutil.copyfile(result_json, dst)
+            print(f"file generated at path: {result_json.resolve()}")
+        result_txt = tmpdir / "output.txt"
+        if sp.returncode == 1 or result_txt.read_text() != "":
+            escape_rot = "\033[31m"
+            print(escape_rot + "errors:")
+            print(result_txt.read_text())
             session.error(1)