diff --git a/docs/source/config_reference/plugins.rst b/docs/source/config_reference/plugins.rst index c7331b33..1fd114ab 100644 --- a/docs/source/config_reference/plugins.rst +++ b/docs/source/config_reference/plugins.rst @@ -3,7 +3,8 @@ The respective plugin files under src/ytdl_sub/plugins/ In order to make a change to this file, edit the respective docstring and run `make docs`. This will automatically sync the Python RST-based - docstrings into this file. + docstrings into this file. If the docstrings and RST file are out of sync, + it will fail TestDocGen tests in GitHub CI. Plugins ======= diff --git a/docs/source/config_reference/scripting/entry_variables.rst b/docs/source/config_reference/scripting/entry_variables.rst index 213f24ea..9ad413e1 100644 --- a/docs/source/config_reference/scripting/entry_variables.rst +++ b/docs/source/config_reference/scripting/entry_variables.rst @@ -3,7 +3,8 @@ src/ytdl_sub/entries/script/variable_definitions.py In order to make a change to this file, edit the respective docstring and run `make docs`. This will automatically sync the Python RST-based - docstrings into this file. + docstrings into this file. If the docstrings and RST file are out of sync, + it will fail TestDocGen tests in GitHub CI. Entry Variables =============== diff --git a/docs/source/config_reference/scripting/scripting_functions.rst b/docs/source/config_reference/scripting/scripting_functions.rst index 67795765..77f945ed 100644 --- a/docs/source/config_reference/scripting/scripting_functions.rst +++ b/docs/source/config_reference/scripting/scripting_functions.rst @@ -3,7 +3,8 @@ The respective function files under src/ytdl_sub/script/functions/ In order to make a change to this file, edit the respective docstring and run `make docs`. This will automatically sync the Python RST-based - docstrings into this file. + docstrings into this file. If the docstrings and RST file are out of sync, + it will fail TestDocGen tests in GitHub CI. Scripting Functions =================== diff --git a/docs/source/config_reference/scripting/static_variables.rst b/docs/source/config_reference/scripting/static_variables.rst index fc16b2fc..fb7699b1 100644 --- a/docs/source/config_reference/scripting/static_variables.rst +++ b/docs/source/config_reference/scripting/static_variables.rst @@ -3,7 +3,8 @@ src/ytdl_sub/entries/variables/override_variables.py In order to make a change to this file, edit the respective docstring and run `make docs`. This will automatically sync the Python RST-based - docstrings into this file. + docstrings into this file. If the docstrings and RST file are out of sync, + it will fail TestDocGen tests in GitHub CI. Static Variables ================ diff --git a/tools/docgen/docgen.py b/tools/docgen/docgen.py index dd3f1ceb..4ea2c4d9 100644 --- a/tools/docgen/docgen.py +++ b/tools/docgen/docgen.py @@ -24,7 +24,8 @@ class DocGen: f" {cls.DOCSTRING_LOCATION}\n" " In order to make a change to this file, edit the respective docstring\n" " and run `make docs`. This will automatically sync the Python RST-based\n" - " docstrings into this file.\n" + " docstrings into this file. If the docstrings and RST file are out of sync,\n" + " it will fail TestDocGen tests in GitHub CI.\n" ) @classmethod