From 7f79323e1fa3efda139259ad3a63adace261be41 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sun, 15 May 2022 22:34:28 -0700 Subject: [PATCH] readthedocs FAQ (#26) --- docs/config.rst | 2 ++ docs/faq.rst | 24 ++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 27 insertions(+) create mode 100644 docs/faq.rst diff --git a/docs/config.rst b/docs/config.rst index d05d9dd1..785c33da 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -93,6 +93,8 @@ output_options ------------------------------------------------------------------------------- +.. _ytdl_options: + ytdl_options """""""""""" .. autoclass:: ytdl_sub.config.preset_options.YTDLOptions() diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..95cdc0f3 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,24 @@ +FAQ +=== + +Since ytdl-sub is relatively new to the public, there has +not been many question asked yet. We will update this as +more questions get asked. + +.. contents:: Frequently Asked Questions + :depth: 3 + +How do I... +----------- + +...download age-restricted YouTube videos? +'''''''''''''''''''''''''''''''''''''''''' +See +`ytdls recommended way `_ +to download your YouTube cookie, then add it to your +:ref:`ytdl options ` section of your config: + +.. code-block:: yaml + + ytdl_options: + cookiefile: "/path/to/cookies/file.txt" diff --git a/docs/index.rst b/docs/index.rst index 6426cb1f..99109045 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,3 +20,4 @@ Contents getting_started config examples + faq