aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile8
-rw-r--r--docs/conf.py10
-rw-r--r--docs/faq.md31
-rw-r--r--docs/index.rst6
-rw-r--r--docs/module_guide.rst8
-rw-r--r--docs/supportedsites.md21
6 files changed, 65 insertions, 19 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 712218045..a7159ff45 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/youtube-dl.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/youtube-dlc.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/youtube-dl.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/youtube-dlc.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/youtube-dl"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/youtube-dl"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/youtube-dlc"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/youtube-dlc"
@echo "# devhelp"
epub:
diff --git a/docs/conf.py b/docs/conf.py
index 0aaf1b8fc..fa616ebbb 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,6 @@
# coding: utf-8
#
-# youtube-dl documentation build configuration file, created by
+# youtube-dlc documentation build configuration file, created by
# sphinx-quickstart on Fri Mar 14 21:05:43 2014.
#
# This file is execfile()d with the current directory set to its
@@ -14,7 +14,7 @@
import sys
import os
-# Allows to import youtube_dl
+# Allows to import youtube_dlc
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
# -- General configuration ------------------------------------------------
@@ -36,7 +36,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'youtube-dl'
+project = u'youtube-dlc'
copyright = u'2014, Ricardo Garcia Gonzalez'
# The version info for the project you're documenting, acts as replacement for
@@ -44,7 +44,7 @@ copyright = u'2014, Ricardo Garcia Gonzalez'
# built documents.
#
# The short X.Y version.
-from youtube_dl.version import __version__
+from youtube_dlc.version import __version__
version = __version__
# The full version, including alpha/beta/rc tags.
release = version
@@ -68,4 +68,4 @@ html_theme = 'default'
html_static_path = ['_static']
# Output file base name for HTML help builder.
-htmlhelp_basename = 'youtube-dldoc'
+htmlhelp_basename = 'youtube-dlcdoc'
diff --git a/docs/faq.md b/docs/faq.md
new file mode 100644
index 000000000..b0f8cad14
--- /dev/null
+++ b/docs/faq.md
@@ -0,0 +1,31 @@
+- Q: How to redirect to another extractor?
+ - A:
+ - Most simple using only `url_result`
+ ```
+ # get proper url first if needed.
+ return self.url_result(url)
+ ```
+ - Using `_request_webpage` and `to_screen` in addition
+ ```
+ urlh = self._request_webpage(
+ url, id, note='Downloading redirect page')
+ url = urlh.geturl()
+ self.to_screen('Following redirect: %s' % url)
+ return self.url_result(url)
+ ```
+ - Using `return` construction
+ ```
+ return {
+ '_type': 'url_transparent',
+ 'url': url,
+ 'ie_key': ExampleIE.ie_key(),
+ 'id': id,
+ }
+ # Alternative if extractor supports internal uri like kaltura
+ return {
+ '_type': 'url_transparent',
+ 'url': 'kaltura:%s:%s' % (partner_id, kaltura_id),
+ 'ie_key': KalturaIE.ie_key(),
+ 'id': id,
+ }
+ ```
diff --git a/docs/index.rst b/docs/index.rst
index b746ff95b..afa26fef1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,13 @@
-Welcome to youtube-dl's documentation!
+Welcome to youtube-dlc's documentation!
======================================
-*youtube-dl* is a command-line program to download videos from YouTube.com and more sites.
+*youtube-dlc* is a command-line program to download videos from YouTube.com and more sites.
It can also be used in Python code.
Developer guide
---------------
-This section contains information for using *youtube-dl* from Python programs.
+This section contains information for using *youtube-dlc* from Python programs.
.. toctree::
:maxdepth: 2
diff --git a/docs/module_guide.rst b/docs/module_guide.rst
index 03d72882e..6413659cf 100644
--- a/docs/module_guide.rst
+++ b/docs/module_guide.rst
@@ -1,11 +1,11 @@
-Using the ``youtube_dl`` module
+Using the ``youtube_dlc`` module
===============================
-When using the ``youtube_dl`` module, you start by creating an instance of :class:`YoutubeDL` and adding all the available extractors:
+When using the ``youtube_dlc`` module, you start by creating an instance of :class:`YoutubeDL` and adding all the available extractors:
.. code-block:: python
- >>> from youtube_dl import YoutubeDL
+ >>> from youtube_dlc import YoutubeDL
>>> ydl = YoutubeDL()
>>> ydl.add_default_info_extractors()
@@ -22,7 +22,7 @@ You use the :meth:`YoutubeDL.extract_info` method for getting the video informat
[youtube] BaW_jenozKc: Downloading video info webpage
[youtube] BaW_jenozKc: Extracting video information
>>> info['title']
- 'youtube-dl test video "\'/\\ä↭𝕐'
+ 'youtube-dlc test video "\'/\\ä↭𝕐'
>>> info['height'], info['width']
(720, 1280)
diff --git a/docs/supportedsites.md b/docs/supportedsites.md
index 5c4e1d58c..10c12b87a 100644
--- a/docs/supportedsites.md
+++ b/docs/supportedsites.md
@@ -6,7 +6,6 @@
- **23video**
- **24video**
- **3qsdn**: 3Q SDN
- - **3sat**
- **4tube**
- **56.com**
- **5min**
@@ -41,6 +40,8 @@
- **AlJazeera**
- **Allocine**
- **AlphaPorno**
+ - **Alura**
+ - **AluraCourse**
- **AMCNetworks**
- **AmericasTestKitchen**
- **anderetijden**: npo.nl, ntr.nl, omroepwnl.nl, zapp.nl and npo3.nl
@@ -209,6 +210,7 @@
- **daum.net:user**
- **DBTV**
- **DctpTv**
+ - **DeezerAlbum**
- **DeezerPlaylist**
- **defense.gouv.fr**
- **democracynow**
@@ -224,6 +226,7 @@
- **Disney**
- **dlive:stream**
- **dlive:vod**
+ - **DoodStream**
- **Dotsub**
- **DouyuShow**
- **DouyuTV**: 斗鱼
@@ -234,6 +237,8 @@
- **drtv**
- **drtv:live**
- **DTube**
+ - **duboku**: www.duboku.co
+ - **duboku:list**: www.duboku.co entire series
- **Dumpert**
- **dvtv**: http://video.aktualne.cz/
- **dw**
@@ -251,6 +256,7 @@
- **EllenTube**
- **EllenTubePlaylist**
- **EllenTubeVideo**
+ - **Elonet**
- **ElPais**: El País
- **Embedly**
- **EMPFlix**
@@ -352,6 +358,7 @@
- **hotstar:playlist**
- **Howcast**
- **HowStuffWorks**
+ - **hrfernsehen**
- **HRTi**
- **HRTiPlaylist**
- **Huajiao**: 花椒直播
@@ -454,6 +461,7 @@
- **lynda**: lynda.com videos
- **lynda:course**: lynda.com online courses
- **m6**
+ - **MagentaMusik360**
- **mailru**: Видео@Mail.Ru
- **mailru:music**: Музыка@Mail.Ru
- **mailru:music:search**: Музыка@Mail.Ru
@@ -524,6 +532,7 @@
- **MySpace:album**
- **MySpass**
- **Myvi**
+ - **MyVideoGe**
- **MyVidster**
- **MyviEmbed**
- **MyVisionTV**
@@ -672,6 +681,7 @@
- **plus.google**: Google Plus
- **podomatic**
- **Pokemon**
+ - **PokemonWatch**
- **PolskieRadio**
- **PolskieRadioCategory**
- **Popcorntimes**
@@ -717,6 +727,8 @@
- **RayWenderlichCourse**
- **RBMARadio**
- **RDS**: RDS.ca
+ - **RedBull**
+ - **RedBullEmbed**
- **RedBullTV**
- **RedBullTVRrnContent**
- **Reddit**
@@ -835,6 +847,9 @@
- **stanfordoc**: Stanford Open ClassRoom
- **Steam**
- **Stitcher**
+ - **StoryFire**
+ - **StoryFireSeries**
+ - **StoryFireUser**
- **Streamable**
- **streamcloud.eu**
- **StreamCZ**
@@ -895,7 +910,6 @@
- **ThisAV**
- **ThisOldHouse**
- **TikTok**
- - **TikTokUser**
- **tinypic**: tinypic.com videos
- **TMZ**
- **TMZArticle**
@@ -940,6 +954,7 @@
- **TVNoe**
- **TVNow**
- **TVNowAnnual**
+ - **TVNowFilm**
- **TVNowNew**
- **TVNowSeason**
- **TVNowShow**
@@ -1147,7 +1162,7 @@
- **Zaq1**
- **Zattoo**
- **ZattooLive**
- - **ZDF**
+ - **ZDF-3sat**
- **ZDFChannel**
- **zingmp3**: mp3.zing.vn
- **Zype**
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-10 20:38:38 +0000