danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

message edit

Browse source
This commit is contained in:
Jesse Bannon 2025-08-17 06:56:23 -07:00
parent 413498639d
commit 8597e102ca
5 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/source/config_reference/plugins.rst
View file

@ -3,7 +3,8 @@
The respective plugin files under src/ytdl_sub/plugins/ The respective plugin files under src/ytdl_sub/plugins/
In order to make a change to this file, edit the respective docstring 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 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 Plugins
======= =======

3
docs/source/config_reference/scripting/entry_variables.rst
View file

@ -3,7 +3,8 @@
src/ytdl_sub/entries/script/variable_definitions.py src/ytdl_sub/entries/script/variable_definitions.py
In order to make a change to this file, edit the respective docstring 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 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 Entry Variables
=============== ===============

3
docs/source/config_reference/scripting/scripting_functions.rst
View file

@ -3,7 +3,8 @@
The respective function files under src/ytdl_sub/script/functions/ The respective function files under src/ytdl_sub/script/functions/
In order to make a change to this file, edit the respective docstring 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 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 Scripting Functions
=================== ===================

3
docs/source/config_reference/scripting/static_variables.rst
View file

@ -3,7 +3,8 @@
src/ytdl_sub/entries/variables/override_variables.py src/ytdl_sub/entries/variables/override_variables.py
In order to make a change to this file, edit the respective docstring 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 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 Static Variables
================ ================

3
tools/docgen/docgen.py
View file

@ -24,7 +24,8 @@ class DocGen:
f" {cls.DOCSTRING_LOCATION}\n" f" {cls.DOCSTRING_LOCATION}\n"
" In order to make a change to this file, edit the respective docstring\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" " 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 @classmethod