config reference

tools/docgen/configuration.py

@@ -0,0 +1,51 @@
+from pathlib import Path
+from typing import Any
+from typing import Dict
+from typing import Type
+
+from tools.docgen.docgen import DocGen
+from tools.docgen.utils import cached_properties
+from tools.docgen.utils import camel_case_to_human
+from tools.docgen.utils import get_function_docs
+from tools.docgen.utils import line_section
+from tools.docgen.utils import section
+from ytdl_sub.entries.script.variable_definitions import VARIABLES
+from ytdl_sub.entries.script.variable_definitions import VariableDefinitions
+
+from ytdl_sub.config.config_validator import ConfigOptions
+
+
+def _variable_class_to_name(obj: Type[Any]) -> str:
+    assert "VariableDefinitions" in obj.__name__, f"{obj.__name__} doesnt have VariableDefinitions"
+    return (
+        camel_case_to_human(obj.__name__)
+        .replace("Variable Definitions", "Variables")
+        .replace("Ytdl Sub", "Ytdl-Sub")
+    )
+
+
+class ConfigurationDocGen(DocGen):
+
+    LOCATION = Path("docs/source/config_reference/config_yaml.rst")
+
+    @classmethod
+    def generate(cls) -> str:
+        docs = section("Configuration File", level=0)
+
+        parent_objs: Dict[str, Type[Any]] = {
+            _variable_class_to_name(obj): obj for obj in ConfigOptions.__bases__
+        }
+
+        for idx, name in enumerate(sorted(parent_objs.keys())):
+            docs += line_section(section_idx=idx)
+            docs += section(name, level=1)
+
+            for variable_function_name in cached_properties(parent_objs[name]):
+                docs += get_function_docs(
+                    function_name=variable_function_name,
+                    obj=parent_objs[name],
+                    pre_docstring=f":type: ``{getattr(VARIABLES, variable_function_name).human_readable_type()}``\n",
+                    level=2,
+                )
+
+        return docs

tools/docgen/plugins.py

@@ -6,7 +6,7 @@ from typing import Optional
 from typing import Type
 
 from tools.docgen.docgen import DocGen
-from tools.docgen.utils import line_section
+from tools.docgen.utils import line_section, get_function_docs
 from tools.docgen.utils import properties
 from tools.docgen.utils import section
 from ytdl_sub.config.overrides import Overrides
@@ -44,13 +44,6 @@ def should_filter_property(property_name: str) -> bool:
     )
 
 
-def get_function_docs(function_name: str, obj: Any, level: int) -> str:
-    docs = f"\n``{function_name}``\n\n"
-    docs += inspect.cleandoc(getattr(obj, function_name).__doc__)
-    docs += "\n\n"
-    return docs
-
-
 def generate_plugin_docs(name: str, options: Type[OptionsValidator], offset: int) -> str:
     docs = ""
     docs += section(name, level=offset + 0)