docs are time consuming
This commit is contained in:
jbannon
parent
ebf859ebad
commit
bbf99947be
9 changed files with 58 additions and 31 deletions
|
|
@ -4,6 +4,7 @@ Examples
|
|||
Hello, WIP
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
|
||||
kodi_tv_shows
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@ Format Variables
|
|||
Hello, WIP
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
|
||||
soundcloud
|
||||
youtube
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ Configuration
|
|||
Hello, WIP
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
|
||||
format_variables/index
|
||||
|
|
|
|||
19
docs/getting_started/index.rst
Normal file
19
docs/getting_started/index.rst
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
Getting Started
|
||||
===============
|
||||
|
||||
The goal of this app is automate the downloading and metadata creation of audio and video files, then place the files
|
||||
in a directory that gets read by your media player/server. Everyone stores and watches their media differently, so
|
||||
we strive for comprehensive and simplistic customization to fit all self-hosting needs.
|
||||
|
||||
Audio metadata is just a matter of adding tags to the audio file. The backend plugin we use supports practically every
|
||||
common audio file type, so there should (hopefully) be no issues getting audio recognized by your media player.
|
||||
|
||||
Video metadata on the other hand, is currently geared toward generating Kodi/Jellyfin/Emby NFO files. Plex uses metadata
|
||||
written within MP4 containers - we do not support that currently, but could be added as a plugin in the future.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
|
||||
usage_ideas
|
||||
install
|
||||
2
docs/getting_started/install.rst
Normal file
2
docs/getting_started/install.rst
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
Install
|
||||
=======
|
||||
28
docs/getting_started/usage_ideas.rst
Normal file
28
docs/getting_started/usage_ideas.rst
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
Usage Ideas
|
||||
===========
|
||||
Below is a list ways you can use ytdl-sub to download and consume different kinds of media in the representation you
|
||||
prefer.
|
||||
|
||||
* Download a Youtube channel
|
||||
* Store the channel as its own TV Show
|
||||
* Use the channel's avatar as the TV Show poster, banner as the fanart
|
||||
* Format the season and episodes as ``Season YYYY/sYYYY.eMMDD - Video Title.mp4`` to easily navigate videos by upload date
|
||||
* Store the channel as a single season under a TV Show shared with other channels
|
||||
* Only download audio, store it as a Podcast
|
||||
* Only keep video/audio uploaded in the last `N` days
|
||||
* Great for news or podcast based channels
|
||||
|
||||
* Download a Youtube playlist
|
||||
* Download an artist's music videos playlist, store each video as a Kodi/Jellyfin/Emby Music Video
|
||||
* Only download the audio, store the playlist as an album
|
||||
|
||||
* Manually download a single Youtube video
|
||||
* Store it as a Movie
|
||||
* Download a one-hit wonder and store it as a Kodi/Jellyfin/Emby Music Video
|
||||
|
||||
* Download a soundcloud artist's discography
|
||||
* Add tags and album cover images so it shows up nicely in your music player
|
||||
|
||||
If you want to jump the gun to see how ytdl-sub can be configured to do these things, head over to the
|
||||
:doc:`examples <../config/examples/index>`.
|
||||
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
Getting Started
|
||||
===============
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
Guides
|
||||
======
|
||||
|
||||
TODO
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting_started
|
||||
|
|
@ -1,10 +1,5 @@
|
|||
.. ytdl-subscribe documentation master file, created by
|
||||
sphinx-quickstart on Wed Apr 13 06:43:04 2022.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
ytdl-sub: Automate ytdl downloads and metadata creation
|
||||
===================================================================
|
||||
ytdl-sub: to enjoy media in your favorite player
|
||||
================================================
|
||||
|
||||
ytdl-sub is an `open-source <https://github.com/jmbannon/ytdl-sub>`_
|
||||
python app that strives to automate downloading media and preparing it for
|
||||
|
|
@ -15,21 +10,12 @@ 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::
|
||||
:titlesonly:
|
||||
:maxdepth: 2
|
||||
|
||||
guides/index
|
||||
getting_started/index
|
||||
config/index
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
|
|||
Loading…
Reference in a new issue