fix paths for doc generation

Author: Carsons-Eels

docs/scripts/copy_repo_docs_to_mkdocs.py

@@ -1,6 +1,7 @@
 """Include EEST's CONTRIBUTING.md and SECURITY.md in the HTML documentation."""
 
 import logging
+import os
 import re
 from pathlib import Path
 
@@ -16,7 +17,7 @@ def copy_markdown_file(source_path, destination_path, fix_links=True):
 
     if not source_file.is_file():
         raise FileNotFoundError(
-            f"Error: Source file '{source_file}' not found in current directory."
+            f"Error: Source file '{source_file}' not found at '{os.getcwd()}'."
         )
 
     try:
@@ -26,7 +27,9 @@ def copy_markdown_file(source_path, destination_path, fix_links=True):
                     if fix_links:
                         # Fix absolute website links to relative docs links
                         line = re.sub(
-                            r"https://eest\.ethereum\.org/main/([^)\s]+)", r"../\1.md", line
+                            r"https://eest\.ethereum\.org/main/([^)\s]+)",
+                            r"../\1.md",
+                            line,
                         )
 
                         # Fix SECURITY.md link
@@ -45,7 +48,9 @@ def copy_markdown_file(source_path, destination_path, fix_links=True):
 
                     destination.write(line)
     except Exception as e:
-        raise Exception(f"Error copying file {source_file} to {destination_file}") from e
+        raise Exception(
+            f"Error copying file {source_file} to {destination_file}"
+        ) from e
 
     logger.info(f"Copied {source_file} to {destination_file}.")
 

docs/scripts/gen_test_case_reference.py

@@ -11,40 +11,46 @@
 import sys
 from os import getenv
 
+import execution_testing.cli.pytest_commands.plugins.filler.gen_test_doc.gen_test_doc as gen_test_doc  # noqa E501
 import pytest
 from click.testing import CliRunner
+from execution_testing.cli.pytest_commands.fill import fill
+from execution_testing.config import DocsConfig
 
-import pytest_plugins.filler.gen_test_doc.gen_test_doc as gen_test_doc
-from cli.pytest_commands.fill import fill
-from config import DocsConfig
-
-importlib.reload(gen_test_doc)  # get changes in plugin to trigger an update for `mkdocs serve`
+importlib.reload(
+    gen_test_doc
+)  # get changes in plugin to trigger an update for `mkdocs serve`
 
 TARGET_FORK = DocsConfig().TARGET_FORK
 GENERATE_UNTIL_FORK = DocsConfig().GENERATE_UNTIL_FORK
 
 logger = logging.getLogger("mkdocs")
 
 
-# if docs are generated while FAST_DOCS is true, then use "tests/frontier" otherwise use "tests"
+# If docs are generated while FAST_DOCS is true, then use "tests/frontier"
+# otherwise use "tests"
+#
 # USAGE 1 (use fast mode):
 #       export FAST_DOCS=true && uv run mkdocs serve
 # USAGE 2 (use fast mode + hide side-effect warnings):
-#       export FAST_DOCS=true && uv run mkdocs serve 2>&1 | sed '/is not found among documentation files/d' # noqa: E501
+#       export FAST_DOCS=true && uv run mkdocs serve 2>&1 | sed '/is not found among documentation files/d' #noqa: E501
 test_arg = "tests"
 fast_mode = getenv("FAST_DOCS")
 if fast_mode is not None:
     if fast_mode.lower() == "true":
-        print("-" * 40, "\nWill generate docs using FAST_DOCS mode.\n" + "-" * 40)
+        print(
+            "-" * 40, "\nWill generate docs using FAST_DOCS mode.\n" + "-" * 40
+        )
         test_arg = "tests/frontier"
 
 args = [
     "--override-ini",
-    "filterwarnings=ignore::pytest.PytestAssertRewriteWarning",  # suppress warnings due to reload
+    # suppress warnings due to reload ⬇️
+    "filterwarnings=ignore::pytest.PytestAssertRewriteWarning",
     "-p",
-    "pytest_plugins.filler.gen_test_doc.gen_test_doc",
+    "execution_testing.cli.filler.gen_test_doc.gen_test_doc",
     "-p",
-    "pytest_plugins.filler.eip_checklist",
+    "execution_testing.cli.filler.eip_checklist",
     "--gen-docs",
     f"--gen-docs-target-fork={TARGET_FORK}",
     f"--until={GENERATE_UNTIL_FORK}",
@@ -58,19 +64,24 @@
 
 runner = CliRunner()
 logger.info(
-    f"Generating documentation for test cases until {GENERATE_UNTIL_FORK} as fill {' '.join(args)}"
+    f"Generating documentation for test cases until {GENERATE_UNTIL_FORK} as \
+    fill {' '.join(args)}"
 )
 result = runner.invoke(fill, args)
 for line in result.output.split("\n"):
     if "===" in line:
         logger.info(line.replace("===", "=="))
         continue
     logger.info(line)
-if result.exit_code in [pytest.ExitCode.OK, pytest.ExitCode.NO_TESTS_COLLECTED]:
+if result.exit_code in [
+    pytest.ExitCode.OK,
+    pytest.ExitCode.NO_TESTS_COLLECTED,
+]:
     logger.info("Documentation generation successful.")
     sys.exit(0)
 logger.error(
-    f"Documentation generation failed (exit: {pytest.ExitCode(result.exit_code)}, "
+    f"Documentation generation failed (exit: \
+        {pytest.ExitCode(result.exit_code)}, "
     f"{pytest.ExitCode(result.exit_code).name})."
 )
 sys.exit(result.exit_code)

docs/scripts/generate_fill_help.py

@@ -51,7 +51,12 @@ def format_help_output(help_text: str, max_width: int = 88) -> str:
 
     for line in lines:
         # Don't wrap lines that are part of the usage section or are empty
-        if not line.strip() or line.startswith("usage:") or line.startswith("  ") and "--" in line:
+        if (
+            not line.strip()
+            or line.startswith("usage:")
+            or line.startswith("  ")
+            and "--" in line
+        ):
             formatted_lines.append(line)
         else:
             # Wrap long lines while preserving indentation
@@ -80,9 +85,10 @@ def generate_command_line_options_docs():
     # Create the complete page content
     page_content = f"""# Fill Command-Line Options
 
-Fill is a [pytest](https://docs.pytest.org/en/stable/)-based command. This page lists custom
-options that the `fill` command provides. To see the full list of options that is available
-to fill (including the standard pytest and plugin command-line options) use `fill --pytest-help`.
+Fill is a [pytest](https://docs.pytest.org/en/stable/)-based command. This page
+lists custom options that the `fill` command provides. To see the full list of
+options that is available to fill (including the standard pytest and plugin
+command-line options) use `fill --pytest-help`.
 
 *This page is automatically generated from the current `fill --help` output.*
 
@@ -98,10 +104,15 @@ def generate_command_line_options_docs():
 """
 
     # Write the generated content to a virtual file
-    with mkdocs_gen_files.open("filling_tests/filling_tests_command_line_options.md", "w") as f:
+    with mkdocs_gen_files.open(
+        "filling_tests/filling_tests_command_line_options.md", "w"
+    ) as f:
         f.write(page_content)
 
-    logger.info("Generated filling_tests_command_line_options.md with current fill --help output")
+    logger.info(
+        "Generated filling_tests_command_line_options.md with current fill \
+            --help output"
+    )
 
 
 # Run the generation

scripts/add_to_whitelist.py

@@ -3,6 +3,7 @@
 import sys
 import os
 
+
 def main():
     # Get words from command-line arguments
     new_words = sys.argv[1:]
@@ -12,15 +13,17 @@ def main():
         print("Example: ./whitelist_manager.py foo bar baz")
         sys.exit(1)
 
-    whitelist_file = 'whitelist.txt'
+    whitelist_file = "whitelist.txt"
 
     # Read existing whitelist (create empty list if file doesn't exist)
     existing_words = []
     if os.path.exists(whitelist_file):
-        with open(whitelist_file, 'r', encoding='utf-8') as f:
+        with open(whitelist_file, "r", encoding="utf-8") as f:
             content = f.read()
-        existing_words = [w.strip() for w in content.split('\n') if w.strip()]
-        print(f"Read {len(existing_words)} existing entries from {whitelist_file}")
+        existing_words = [w.strip() for w in content.split("\n") if w.strip()]
+        print(
+            f"Read {len(existing_words)} existing entries from {whitelist_file}"
+        )
     else:
         print(f"Creating new {whitelist_file}")
 
@@ -36,26 +39,30 @@ def main():
 
     # Add blank lines before each new letter
     words_with_separators = []
-    previous_letter = ''
+    previous_letter = ""
 
     for word in sorted_words:
         current_letter = word[0].lower()
 
         # If we're starting a new letter (and it's not the first word), add a blank line
-        if current_letter != previous_letter and len(words_with_separators) > 0:
-            words_with_separators.append('')
+        if (
+            current_letter != previous_letter
+            and len(words_with_separators) > 0
+        ):
+            words_with_separators.append("")
 
         words_with_separators.append(word)
         previous_letter = current_letter
 
     # Create the whitelist content
-    whitelist_content = '\n'.join(words_with_separators)
+    whitelist_content = "\n".join(words_with_separators)
 
     # Write to whitelist file
-    with open(whitelist_file, 'w', encoding='utf-8') as f:
+    with open(whitelist_file, "w", encoding="utf-8") as f:
         f.write(whitelist_content)
 
     print(f"\nSuccessfully updated {whitelist_file}")
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     main()

tox.ini

@@ -139,8 +139,8 @@ setenv =
     # https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/?h=cairo#cairo-library-was-not-found
 package = editable
 commands =
-    ruff check --no-fix --show-fixes docs/scripts
-    ruff format --check docs/scripts
+    ruff check --no-fix --show-fixes docs/scripts/
+    ruff format --check docs/scripts/
     mkdocs build --strict
 
 [testenv:markdownlint]