From 3e29a3396889a894b4257f6f33c9b5a91a50fff9 Mon Sep 17 00:00:00 2001 From: jbannon Date: Sun, 24 Apr 2022 04:30:35 +0000 Subject: [PATCH] get doc layout started --- docs/conf.py | 2 +- docs/config/examples/index.rst | 9 +++ docs/config/examples/kodi_tv_shows.rst | 12 ++++ docs/config/format_variables/index.rst | 10 +++ docs/config/format_variables/soundcloud.rst | 7 +++ docs/config/format_variables/youtube.rst | 7 +++ docs/config/index.rst | 10 +++ docs/guides/getting_started.rst | 2 + docs/guides/index.rst | 9 +++ docs/index.rst | 6 +- docs/source/modules.rst | 7 --- docs/source/ytdl_subscribe.cli.rst | 29 --------- docs/source/ytdl_subscribe.config.rst | 53 ---------------- docs/source/ytdl_subscribe.downloaders.rst | 37 ----------- docs/source/ytdl_subscribe.entries.rst | 53 ---------------- .../ytdl_subscribe.entries.variables.rst | 37 ----------- docs/source/ytdl_subscribe.plugins.rst | 53 ---------------- docs/source/ytdl_subscribe.rst | 37 ----------- docs/source/ytdl_subscribe.subscriptions.rst | 21 ------- docs/source/ytdl_subscribe.utils.rst | 21 ------- .../source/ytdl_subscribe.validators.base.rst | 53 ---------------- ...cribe.validators.config.config_options.rst | 21 ------- ...ibe.validators.config.metadata_options.rst | 37 ----------- ...cribe.validators.config.output_options.rst | 21 ------- ..._subscribe.validators.config.overrides.rst | 21 ------- .../ytdl_subscribe.validators.config.rst | 50 --------------- ...cribe.validators.config.source_options.rst | 53 ---------------- ...bscribe.validators.config.ytdl_options.rst | 21 ------- docs/source/ytdl_subscribe.validators.rst | 61 ------------------- docs/source/ytdl_subscribe.ytdl_additions.rst | 21 ------- tools/docs | 2 +- 31 files changed, 73 insertions(+), 710 deletions(-) create mode 100644 docs/config/examples/index.rst create mode 100644 docs/config/examples/kodi_tv_shows.rst create mode 100644 docs/config/format_variables/index.rst create mode 100644 docs/config/format_variables/soundcloud.rst create mode 100644 docs/config/format_variables/youtube.rst create mode 100644 docs/config/index.rst delete mode 100644 docs/source/modules.rst delete mode 100644 docs/source/ytdl_subscribe.cli.rst delete mode 100644 docs/source/ytdl_subscribe.config.rst delete mode 100644 docs/source/ytdl_subscribe.downloaders.rst delete mode 100644 docs/source/ytdl_subscribe.entries.rst delete mode 100644 docs/source/ytdl_subscribe.entries.variables.rst delete mode 100644 docs/source/ytdl_subscribe.plugins.rst delete mode 100644 docs/source/ytdl_subscribe.rst delete mode 100644 docs/source/ytdl_subscribe.subscriptions.rst delete mode 100644 docs/source/ytdl_subscribe.utils.rst delete mode 100644 docs/source/ytdl_subscribe.validators.base.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.config_options.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.metadata_options.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.output_options.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.overrides.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.source_options.rst delete mode 100644 docs/source/ytdl_subscribe.validators.config.ytdl_options.rst delete mode 100644 docs/source/ytdl_subscribe.validators.rst delete mode 100644 docs/source/ytdl_subscribe.ytdl_additions.rst diff --git a/docs/conf.py b/docs/conf.py index e5d7e46c..adacd2f4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +# html_static_path = ["_static"] # Do not show full module path in api docs add_module_names = False diff --git a/docs/config/examples/index.rst b/docs/config/examples/index.rst new file mode 100644 index 00000000..82de5279 --- /dev/null +++ b/docs/config/examples/index.rst @@ -0,0 +1,9 @@ +Examples +======== + +Hello, WIP + +.. toctree:: + :maxdepth: 3 + + kodi_tv_shows diff --git a/docs/config/examples/kodi_tv_shows.rst b/docs/config/examples/kodi_tv_shows.rst new file mode 100644 index 00000000..91895320 --- /dev/null +++ b/docs/config/examples/kodi_tv_shows.rst @@ -0,0 +1,12 @@ +Kodi/Jellyfin TV Shows +====================== + +Config + +.. include:: ../../../examples/kodi_tv_shows_config.yaml + :literal: + + + +.. include:: ../../../examples/kodi_tv_shows_subscriptions.yaml + :literal: diff --git a/docs/config/format_variables/index.rst b/docs/config/format_variables/index.rst new file mode 100644 index 00000000..698800bb --- /dev/null +++ b/docs/config/format_variables/index.rst @@ -0,0 +1,10 @@ +Format Variables +================ + +Hello, WIP + +.. toctree:: + :maxdepth: 3 + + soundcloud + youtube diff --git a/docs/config/format_variables/soundcloud.rst b/docs/config/format_variables/soundcloud.rst new file mode 100644 index 00000000..10dc96ba --- /dev/null +++ b/docs/config/format_variables/soundcloud.rst @@ -0,0 +1,7 @@ +Soundcloud Track +---------------- + +.. automodule:: ytdl_subscribe.entries.variables.soundcloud_variables + :members: + :inherited-members: + :undoc-members: diff --git a/docs/config/format_variables/youtube.rst b/docs/config/format_variables/youtube.rst new file mode 100644 index 00000000..2581473a --- /dev/null +++ b/docs/config/format_variables/youtube.rst @@ -0,0 +1,7 @@ +Youtube Video +------------- + +.. automodule:: ytdl_subscribe.entries.variables.youtube_variables + :members: + :inherited-members: + :undoc-members: diff --git a/docs/config/index.rst b/docs/config/index.rst new file mode 100644 index 00000000..47cb81ee --- /dev/null +++ b/docs/config/index.rst @@ -0,0 +1,10 @@ +Configuration +============= + +Hello, WIP + +.. toctree:: + :maxdepth: 2 + + format_variables/index + examples/index diff --git a/docs/guides/getting_started.rst b/docs/guides/getting_started.rst index e69de29b..c3ce665d 100644 --- a/docs/guides/getting_started.rst +++ b/docs/guides/getting_started.rst @@ -0,0 +1,2 @@ +Getting Started +=============== \ No newline at end of file diff --git a/docs/guides/index.rst b/docs/guides/index.rst index e69de29b..a01af221 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -0,0 +1,9 @@ +Guides +====== + +TODO + +.. toctree:: + :maxdepth: 2 + + getting_started diff --git a/docs/index.rst b/docs/index.rst index 9eecbbcf..8d003753 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,12 +15,16 @@ If you are new to ytdl-sub, head over to the Getting Started page. This guide shows how you can install ytdl-sub, configure it to download various types of media, and start downloading. +:doc:`test link to variable ` +Contents +======== .. toctree:: :maxdepth: 2 - :caption: Contents: + guides/index + config/index Indices and tables diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index 95f6f909..00000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -ytdl_subscribe -============== - -.. toctree:: - :maxdepth: 4 - - ytdl_subscribe diff --git a/docs/source/ytdl_subscribe.cli.rst b/docs/source/ytdl_subscribe.cli.rst deleted file mode 100644 index 22a8027f..00000000 --- a/docs/source/ytdl_subscribe.cli.rst +++ /dev/null @@ -1,29 +0,0 @@ -ytdl\_subscribe.cli package -=========================== - -Submodules ----------- - -ytdl\_subscribe.cli.download\_args\_parser module -------------------------------------------------- - -.. automodule:: ytdl_subscribe.cli.download_args_parser - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.cli.main\_args\_parser module ---------------------------------------------- - -.. automodule:: ytdl_subscribe.cli.main_args_parser - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.cli - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.config.rst b/docs/source/ytdl_subscribe.config.rst deleted file mode 100644 index 9468672c..00000000 --- a/docs/source/ytdl_subscribe.config.rst +++ /dev/null @@ -1,53 +0,0 @@ -ytdl\_subscribe.config package -============================== - -Submodules ----------- - -ytdl\_subscribe.config.config\_file module ------------------------------------------- - -.. automodule:: ytdl_subscribe.config.config_file - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.config.preset module ------------------------------------- - -.. automodule:: ytdl_subscribe.config.preset - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.config.preset\_class\_mappings module ------------------------------------------------------ - -.. automodule:: ytdl_subscribe.config.preset_class_mappings - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.config.preset\_options module ---------------------------------------------- - -.. automodule:: ytdl_subscribe.config.preset_options - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.config.subscription module ------------------------------------------- - -.. automodule:: ytdl_subscribe.config.subscription - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.config - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.downloaders.rst b/docs/source/ytdl_subscribe.downloaders.rst deleted file mode 100644 index e96e85e4..00000000 --- a/docs/source/ytdl_subscribe.downloaders.rst +++ /dev/null @@ -1,37 +0,0 @@ -ytdl\_subscribe.downloaders package -=================================== - -Submodules ----------- - -ytdl\_subscribe.downloaders.downloader module ---------------------------------------------- - -.. automodule:: ytdl_subscribe.downloaders.downloader - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.downloaders.soundcloud\_downloader module ---------------------------------------------------------- - -.. automodule:: ytdl_subscribe.downloaders.soundcloud_downloader - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.downloaders.youtube\_downloader module ------------------------------------------------------- - -.. automodule:: ytdl_subscribe.downloaders.youtube_downloader - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.downloaders - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.entries.rst b/docs/source/ytdl_subscribe.entries.rst deleted file mode 100644 index aa3768f8..00000000 --- a/docs/source/ytdl_subscribe.entries.rst +++ /dev/null @@ -1,53 +0,0 @@ -ytdl\_subscribe.entries package -=============================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - ytdl_subscribe.entries.variables - -Submodules ----------- - -ytdl\_subscribe.entries.base\_entry module ------------------------------------------- - -.. automodule:: ytdl_subscribe.entries.base_entry - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.entries.entry module ------------------------------------- - -.. automodule:: ytdl_subscribe.entries.entry - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.entries.soundcloud module ------------------------------------------ - -.. automodule:: ytdl_subscribe.entries.soundcloud - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.entries.youtube module --------------------------------------- - -.. automodule:: ytdl_subscribe.entries.youtube - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.entries - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.entries.variables.rst b/docs/source/ytdl_subscribe.entries.variables.rst deleted file mode 100644 index 15999e03..00000000 --- a/docs/source/ytdl_subscribe.entries.variables.rst +++ /dev/null @@ -1,37 +0,0 @@ -ytdl\_subscribe.entries.variables package -========================================= - -Submodules ----------- - -ytdl\_subscribe.entries.variables.entry\_variables module ---------------------------------------------------------- - -.. automodule:: ytdl_subscribe.entries.variables.entry_variables - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.entries.variables.soundcloud\_variables module --------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.entries.variables.soundcloud_variables - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.entries.variables.youtube\_variables module ------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.entries.variables.youtube_variables - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.entries.variables - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.plugins.rst b/docs/source/ytdl_subscribe.plugins.rst deleted file mode 100644 index eee04df7..00000000 --- a/docs/source/ytdl_subscribe.plugins.rst +++ /dev/null @@ -1,53 +0,0 @@ -ytdl\_subscribe.plugins package -=============================== - -Submodules ----------- - -ytdl\_subscribe.plugins.convert\_thumbnail module -------------------------------------------------- - -.. automodule:: ytdl_subscribe.plugins.convert_thumbnail - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.plugins.music\_tags module ------------------------------------------- - -.. automodule:: ytdl_subscribe.plugins.music_tags - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.plugins.nfo\_tags module ----------------------------------------- - -.. automodule:: ytdl_subscribe.plugins.nfo_tags - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.plugins.output\_directory\_nfo\_tags module ------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.plugins.output_directory_nfo_tags - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.plugins.plugin module -------------------------------------- - -.. automodule:: ytdl_subscribe.plugins.plugin - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.plugins - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.rst b/docs/source/ytdl_subscribe.rst deleted file mode 100644 index 82a140f7..00000000 --- a/docs/source/ytdl_subscribe.rst +++ /dev/null @@ -1,37 +0,0 @@ -ytdl\_subscribe package -======================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - ytdl_subscribe.cli - ytdl_subscribe.config - ytdl_subscribe.downloaders - ytdl_subscribe.entries - ytdl_subscribe.plugins - ytdl_subscribe.subscriptions - ytdl_subscribe.utils - ytdl_subscribe.validators - ytdl_subscribe.ytdl_additions - -Submodules ----------- - -ytdl\_subscribe.main module ---------------------------- - -.. automodule:: ytdl_subscribe.main - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.subscriptions.rst b/docs/source/ytdl_subscribe.subscriptions.rst deleted file mode 100644 index 9338ecc9..00000000 --- a/docs/source/ytdl_subscribe.subscriptions.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.subscriptions package -===================================== - -Submodules ----------- - -ytdl\_subscribe.subscriptions.subscription module -------------------------------------------------- - -.. automodule:: ytdl_subscribe.subscriptions.subscription - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.subscriptions - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.utils.rst b/docs/source/ytdl_subscribe.utils.rst deleted file mode 100644 index eda7eeb9..00000000 --- a/docs/source/ytdl_subscribe.utils.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.utils package -============================= - -Submodules ----------- - -ytdl\_subscribe.utils.exceptions module ---------------------------------------- - -.. automodule:: ytdl_subscribe.utils.exceptions - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.base.rst b/docs/source/ytdl_subscribe.validators.base.rst deleted file mode 100644 index 3723a9ed..00000000 --- a/docs/source/ytdl_subscribe.validators.base.rst +++ /dev/null @@ -1,53 +0,0 @@ -ytdl\_subscribe.validators.base package -======================================= - -Submodules ----------- - -ytdl\_subscribe.validators.base.strict\_dict\_validator module --------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.base.strict_dict_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.base.string\_datetime module -------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.base.string_datetime - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.base.string\_formatter\_validators module --------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.base.string_formatter_validators - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.base.string\_select\_validator module ----------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.base.string_select_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.base.validators module -------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.base.validators - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.base - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.config_options.rst b/docs/source/ytdl_subscribe.validators.config.config_options.rst deleted file mode 100644 index c3d35a84..00000000 --- a/docs/source/ytdl_subscribe.validators.config.config_options.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.validators.config.config\_options package -========================================================= - -Submodules ----------- - -ytdl\_subscribe.validators.config.config\_options.config\_options\_validator module ------------------------------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.validators.config.config_options.config_options_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.config_options - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.metadata_options.rst b/docs/source/ytdl_subscribe.validators.config.metadata_options.rst deleted file mode 100644 index 5bbdaeb5..00000000 --- a/docs/source/ytdl_subscribe.validators.config.metadata_options.rst +++ /dev/null @@ -1,37 +0,0 @@ -ytdl\_subscribe.validators.config.metadata\_options package -=========================================================== - -Submodules ----------- - -ytdl\_subscribe.validators.config.metadata\_options.id3\_validator module -------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.metadata_options.id3_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.metadata\_options.metadata\_options\_validator module ---------------------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.metadata_options.metadata_options_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.metadata\_options.nfo\_validator module -------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.metadata_options.nfo_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.metadata_options - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.output_options.rst b/docs/source/ytdl_subscribe.validators.config.output_options.rst deleted file mode 100644 index 322c6c9a..00000000 --- a/docs/source/ytdl_subscribe.validators.config.output_options.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.validators.config.output\_options package -========================================================= - -Submodules ----------- - -ytdl\_subscribe.validators.config.output\_options.output\_options\_validator module ------------------------------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.validators.config.output_options.output_options_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.output_options - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.overrides.rst b/docs/source/ytdl_subscribe.validators.config.overrides.rst deleted file mode 100644 index 30b45992..00000000 --- a/docs/source/ytdl_subscribe.validators.config.overrides.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.validators.config.overrides package -=================================================== - -Submodules ----------- - -ytdl\_subscribe.validators.config.overrides.overrides\_validator module ------------------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.validators.config.overrides.overrides_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.overrides - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.rst b/docs/source/ytdl_subscribe.validators.config.rst deleted file mode 100644 index c9632508..00000000 --- a/docs/source/ytdl_subscribe.validators.config.rst +++ /dev/null @@ -1,50 +0,0 @@ -ytdl\_subscribe.validators.config package -========================================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - ytdl_subscribe.validators.config.config_options - ytdl_subscribe.validators.config.metadata_options - ytdl_subscribe.validators.config.output_options - ytdl_subscribe.validators.config.overrides - ytdl_subscribe.validators.config.source_options - ytdl_subscribe.validators.config.ytdl_options - -Submodules ----------- - -ytdl\_subscribe.validators.config.config\_file\_validator module ----------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.config_file_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.preset\_validator module ----------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.preset_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.subscription\_validator module ----------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.subscription_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.source_options.rst b/docs/source/ytdl_subscribe.validators.config.source_options.rst deleted file mode 100644 index c5856510..00000000 --- a/docs/source/ytdl_subscribe.validators.config.source_options.rst +++ /dev/null @@ -1,53 +0,0 @@ -ytdl\_subscribe.validators.config.source\_options package -========================================================= - -Submodules ----------- - -ytdl\_subscribe.validators.config.source\_options.download\_strategy\_validators module ---------------------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options.download_strategy_validators - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.source\_options.mixins module ---------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options.mixins - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.source\_options.soundcloud\_validators module -------------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options.soundcloud_validators - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.source\_options.source\_validators module ---------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options.source_validators - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.config.source\_options.youtube\_validators module ----------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options.youtube_validators - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.source_options - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.config.ytdl_options.rst b/docs/source/ytdl_subscribe.validators.config.ytdl_options.rst deleted file mode 100644 index 509abe45..00000000 --- a/docs/source/ytdl_subscribe.validators.config.ytdl_options.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.validators.config.ytdl\_options package -======================================================= - -Submodules ----------- - -ytdl\_subscribe.validators.config.ytdl\_options.ytdl\_options\_validator module -------------------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.config.ytdl_options.ytdl_options_validator - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators.config.ytdl_options - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.validators.rst b/docs/source/ytdl_subscribe.validators.rst deleted file mode 100644 index 3813db85..00000000 --- a/docs/source/ytdl_subscribe.validators.rst +++ /dev/null @@ -1,61 +0,0 @@ -ytdl\_subscribe.validators package -================================== - -Submodules ----------- - -ytdl\_subscribe.validators.date\_range\_validator module --------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.date_range_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.strict\_dict\_validator module ---------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.strict_dict_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.string\_datetime module --------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.string_datetime - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.string\_formatter\_validators module ---------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.string_formatter_validators - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.string\_select\_validator module ------------------------------------------------------------ - -.. automodule:: ytdl_subscribe.validators.string_select_validator - :members: - :undoc-members: - :show-inheritance: - -ytdl\_subscribe.validators.validators module --------------------------------------------- - -.. automodule:: ytdl_subscribe.validators.validators - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.validators - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/ytdl_subscribe.ytdl_additions.rst b/docs/source/ytdl_subscribe.ytdl_additions.rst deleted file mode 100644 index 77fc21ed..00000000 --- a/docs/source/ytdl_subscribe.ytdl_additions.rst +++ /dev/null @@ -1,21 +0,0 @@ -ytdl\_subscribe.ytdl\_additions package -======================================= - -Submodules ----------- - -ytdl\_subscribe.ytdl\_additions.enhanced\_download\_archive module ------------------------------------------------------------------- - -.. automodule:: ytdl_subscribe.ytdl_additions.enhanced_download_archive - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: ytdl_subscribe.ytdl_additions - :members: - :undoc-members: - :show-inheritance: diff --git a/tools/docs b/tools/docs index 99c18101..45ec090d 100755 --- a/tools/docs +++ b/tools/docs @@ -1,4 +1,4 @@ # Uncomment to build api docs -sphinx-apidoc -f -o docs/source ytdl_subscribe +# sphinx-apidoc -f -o docs/source ytdl_subscribe sphinx-build -a -b html docs docs/_html