doc: Fixup references (#286)

Author: eddiebergman

docs/guides/scheduling.md

@@ -424,6 +424,8 @@ However, there are more explicit methods.
 
     ```python exec="true" source="material-block" html="True" hl_lines="20"
     import time
+    from asyncio import Future
+
     from amltk.scheduling import Scheduler
 
     scheduler = Scheduler.with_processes(1)
@@ -437,7 +439,7 @@ However, there are more explicit methods.
     def submit_calculations() -> None:
         scheduler.submit(expensive_function)
 
-    # The will endlessly loop the scheduler
+    # This will endlessly loop the scheduler
     @scheduler.on_future_done
     def submit_again(future: Future) -> None:
         if scheduler.running():
@@ -468,6 +470,7 @@ the default, but it also takes three other possibilities:
 One example is to just `stop()` the scheduler when some exception occurs.
 
 ```python exec="true" source="material-block" html="True" hl_lines="12-15"
+from asyncio import Future
 from amltk.scheduling import Scheduler
 
 scheduler = Scheduler.with_processes(1)

docs/hooks/cleanup_log_output.py

@@ -13,7 +13,7 @@
 import mkdocs.plugins
 import mkdocs.structure.pages
 
-from amltk.exceptions import AutomaticParameterWarning, TaskTypeWarning
+from amltk.exceptions import AutomaticParameterWarning
 
 log = logging.getLogger("mkdocs")
 

docs/hooks/debug_which_page_is_being_rendered.py

@@ -8,21 +8,12 @@
 import mkdocs
 import mkdocs.plugins
 import mkdocs.structure.pages
-import os
 
 log = logging.getLogger("mkdocs")
 
-RENDER_EXAMPLES_ENV_VAR = "AMLTK_DOC_RENDER_EXAMPLES"
-EXEC_DOCS_ENV_VAR = "AMLTK_EXEC_DOCS"
-
-truthy_values = {"yes", "on", "true", "1", "all"}
-
 def on_pre_page(
     page: mkdocs.structure.pages.Page,
     config: Any,
     files: Any,
 ) -> mkdocs.structure.pages.Page | None:
-    render_examples = os.environ.get(RENDER_EXAMPLES_ENV_VAR, "true")
-    render_code = os.environ.get(EXEC_DOCS_ENV_VAR, "true")
-    if render_examples.lower() in truthy_values or render_code.lower() in truthy_values:
-        log.info(f"{page.file.src_path}")
+    log.info(f"{page.file.src_path}")

docs/hooks/disable_markdown_exec.py

@@ -22,7 +22,7 @@
 logger = logging.getLogger("mkdocs")
 
 
-def _print_msg(compiled_code: Any, exec_globals: dict) -> None:
+def _print_msg(compiled_code: Any, code_block_id: int, exec_globals: dict) -> None:
     _print = exec_globals["print"]
     _print(
         f"Env variable {RUN_CODE_BLOCKS_ENV_VAR}=0 - No code to display."
@@ -42,5 +42,5 @@ def on_startup(**kwargs: Any):
         )
         from markdown_exec.formatters import python
 
-        setattr(python, "exec", _print_msg)
+        setattr(python, "exec_python", _print_msg)