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

get doc layout started

Browse source
This commit is contained in:
jbannon 2022-04-24 04:30:35 +00:00
parent 5eeb117fca
commit 3e29a33968
31 changed files with 73 additions and 710 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/conf.py
View file

@ -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

9
docs/config/examples/index.rst Normal file
View file

@ -0,0 +1,9 @@
Examples
========
Hello, WIP
.. toctree::
:maxdepth: 3
kodi_tv_shows

12
docs/config/examples/kodi_tv_shows.rst Normal file
View file

@ -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:

10
docs/config/format_variables/index.rst Normal file
View file

@ -0,0 +1,10 @@
Format Variables
================
Hello, WIP
.. toctree::
:maxdepth: 3
soundcloud
youtube

7
docs/config/format_variables/soundcloud.rst Normal file
View file

@ -0,0 +1,7 @@
Soundcloud Track
----------------
.. automodule:: ytdl_subscribe.entries.variables.soundcloud_variables
:members:
:inherited-members:
:undoc-members:

7
docs/config/format_variables/youtube.rst Normal file
View file

@ -0,0 +1,7 @@
Youtube Video
-------------
.. automodule:: ytdl_subscribe.entries.variables.youtube_variables
:members:
:inherited-members:
:undoc-members:

10
docs/config/index.rst Normal file
View file

@ -0,0 +1,10 @@
Configuration
=============
Hello, WIP
.. toctree::
:maxdepth: 2
format_variables/index
examples/index

2
docs/guides/getting_started.rst
View file

@ -0,0 +1,2 @@
Getting Started
===============

9
docs/guides/index.rst
View file

@ -0,0 +1,9 @@
Guides
======
TODO
.. toctree::
:maxdepth: 2
getting_started

6
docs/index.rst
View file

@ -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 </config/index>`
Contents
========
.. toctree::
:maxdepth: 2
:caption: Contents:
guides/index
config/index
Indices and tables

7
docs/source/modules.rst
View file

@ -1,7 +0,0 @@
ytdl_subscribe
==============
.. toctree::
:maxdepth: 4
ytdl_subscribe

29
docs/source/ytdl_subscribe.cli.rst
View file

@ -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:

53
docs/source/ytdl_subscribe.config.rst
View file

@ -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:

37
docs/source/ytdl_subscribe.downloaders.rst
View file

@ -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:

53
docs/source/ytdl_subscribe.entries.rst
View file

@ -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:

37
docs/source/ytdl_subscribe.entries.variables.rst
View file

@ -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:

53
docs/source/ytdl_subscribe.plugins.rst
View file

@ -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:

37
docs/source/ytdl_subscribe.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.subscriptions.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.utils.rst
View file

@ -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:

53
docs/source/ytdl_subscribe.validators.base.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.validators.config.config_options.rst
View file

@ -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:

37
docs/source/ytdl_subscribe.validators.config.metadata_options.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.validators.config.output_options.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.validators.config.overrides.rst
View file

@ -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:

50
docs/source/ytdl_subscribe.validators.config.rst
View file

@ -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:

53
docs/source/ytdl_subscribe.validators.config.source_options.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.validators.config.ytdl_options.rst
View file

@ -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:

61
docs/source/ytdl_subscribe.validators.rst
View file

@ -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:

21
docs/source/ytdl_subscribe.ytdl_additions.rst
View file

@ -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:

2
tools/docs
View file

@ -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