From 4572c122d823ec4510d26cf4cb5df8c2609c73e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mike=20F=C3=A4hrmann?= Date: Mon, 30 Jan 2023 23:32:36 +0100 Subject: [PATCH] document 'extractor.module-sources' --- docs/configuration.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 9d4730da..8702d935 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -4518,10 +4518,29 @@ Default Example ``["reddit", "danbooru", "mangadex"]`` Description - The list of modules to load when searching for a suitable + List of internal modules to load when searching for a suitable extractor class. Useful to reduce startup time and memory usage. +extractor.module-sources +------------------------ +Type + ``list`` of |Path|_ instances +Example + ``["~/.config/gallery-dl/modules", null]`` +Description + List of directories to load external extractor modules from. + + Any file in a specified directory with a ``.py`` filename extension + gets `imported `__ + and searched for potential extractors, + i.e. classes with a ``pattern`` attribute. + + Note: ``null`` references internal extractors defined in + `extractor/__init__.py <../gallery_dl/extractor/__init__.py#L12>`__ + or by `extractor.modules`_. + + cache.file ---------- Type