Find scripts relative to mkdocs.yml, not current directory

README.md

@@ -18,7 +18,7 @@ pip install mkdocs-gen-files
 
 ## Usage
 
-Activate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute):
+Activate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute, always relative to **mkdocs.yml**):
 
 ```yaml
 plugins:
@@ -28,7 +28,7 @@ plugins:
         - gen_pages.py  # or any other name or path
 ```
 
-Then create such a script **gen_pages.py** (this is relative to the root, *not* to the *docs* directory).
+Then create such a script **gen_pages.py** (this is relative to the root, *not* to the **docs** directory).
 
 ```python
 import mkdocs_gen_files

docs/index.md

@@ -13,7 +13,7 @@ pip install mkdocs-gen-files
 
 ## Usage
 
-Activate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute):
+Activate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute, always relative to **mkdocs.yml**):
 
 ```yaml
 plugins:
@@ -60,4 +60,3 @@ Note that this happens before MkDocs reads any of the doc files, so all of the o
 All file modes are supported (even e.g. `ab+`). You could even open a file to read it, replace something in it, and write it back anew. Though at that point you may be better served by the ["macros" plugin](https://github.com/fralau/mkdocs_macros_plugin/).
 
 Note that this function is separate from the top-level built-in `open()`, which is unaffected and can still be used normally, relative to the current working directory (which is *not* changed to **./docs/**, instead it's just the directory that you ran `mkdocs` from).
-

mkdocs_gen_files/config.py

@@ -0,0 +1,25 @@
+from mkdocs.config.config_options import File, OptionallyRequired
+
+
+class ListOfItems(OptionallyRequired):
+    def __init__(self, option_type, default=[], required=False):
+        super().__init__(default, required)
+        self.option_type = option_type
+        self.option_type.warnings = self.warnings
+
+    def pre_validation(self, config, key_name):
+        self._config = config
+        self._key_name = key_name
+
+    def run_validation(self, value):
+        result = []
+        for item in value:
+            self.option_type.pre_validation(self._config, self._key_name)
+            result.append(self.option_type.validate(item))
+            self.option_type.post_validation(self._config, self._key_name)
+        return result
+
+
+class ListOfFiles(ListOfItems):
+    def __init__(self):
+        super().__init__(File(exists=True))

mkdocs_gen_files/plugin.py

@@ -5,7 +5,7 @@
 import urllib.parse
 
 import mkdocs.utils
-from mkdocs.config import Config, config_options
+from mkdocs.config import Config
 from mkdocs.plugins import BasePlugin
 from mkdocs.structure.files import Files
 from mkdocs.structure.pages import Page
@@ -15,19 +15,20 @@
 except ImportError:
     PluginError = SystemExit
 
-from . import editor
+from .config import ListOfFiles
+from .editor import FilesEditor
 
 log = logging.getLogger(f"mkdocs.plugins.{__name__}")
 log.addFilter(mkdocs.utils.warning_filter)
 
 
 class GenFilesPlugin(BasePlugin):
-    config_scheme = (("scripts", config_options.Type(list)),)
+    config_scheme = (("scripts", ListOfFiles()),)
 
     def on_files(self, files: Files, config: Config) -> Files:
         self._dir = tempfile.TemporaryDirectory(prefix="mkdocs_gen_files_")
 
-        with editor.FilesEditor(files, config, self._dir.name) as ed:
+        with FilesEditor(files, config, self._dir.name) as ed:
             for file_name in self.config["scripts"]:
                 try:
                     runpy.run_path(file_name)