a758a8870d
Updates the configuration file's docs to be cleaner. Removes sphinx autodocs entirely in favor of our custom-built one.
34 lines
1.1 KiB
Python
34 lines
1.1 KiB
Python
from typing import Type
|
|
|
|
from tools.docgen.configuration import ConfigurationDocGen
|
|
from tools.docgen.docgen import DocGen
|
|
from tools.docgen.entry_variables import EntryVariablesDocGen
|
|
from tools.docgen.plugins import PluginsDocGen
|
|
from tools.docgen.scripting_functions import ScriptingFunctionsDocGen
|
|
from tools.docgen.static_variables import StaticVariablesDocGen
|
|
from ytdl_sub.utils.file_handler import get_md5_hash
|
|
|
|
|
|
def _test_doc_gen(doc_gen: Type[DocGen]) -> None:
|
|
expected_md5_hash = get_md5_hash(doc_gen.generate_and_maybe_write_to_file())
|
|
with open(doc_gen.LOCATION, "r", encoding="utf-8") as file_doc:
|
|
md5_hash = get_md5_hash(file_doc.read())
|
|
|
|
assert md5_hash == expected_md5_hash
|
|
|
|
|
|
class TestDocGen:
|
|
def test_entry_variables_generated(self):
|
|
_test_doc_gen(EntryVariablesDocGen)
|
|
|
|
def test_static_variables_generated(self):
|
|
_test_doc_gen(StaticVariablesDocGen)
|
|
|
|
def test_scripting_functions_generated(self):
|
|
_test_doc_gen(ScriptingFunctionsDocGen)
|
|
|
|
def test_plugins_generated(self):
|
|
_test_doc_gen(PluginsDocGen)
|
|
|
|
def test_configuration_generated(self):
|
|
_test_doc_gen(ConfigurationDocGen)
|