diff options
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/index.rst | 23 | ||||
| -rw-r--r-- | docs/module_guide.rst | 66 | ||||
| -rw-r--r-- | setup.py | 2 | ||||
| -rw-r--r-- | yt_dlp/options.py | 2 |
6 files changed, 6 insertions, 93 deletions
@@ -9,6 +9,7 @@ [](https://github.com/yt-dlp/yt-dlp/commits) [](https://github.com/yt-dlp/yt-dlp/releases/latest) [](https://pypi.org/project/yt-dlp) +[](https://yt-dlp.readthedocs.io) A command-line program to download videos from youtube.com and many other [video platforms](docs/supportedsites.md) @@ -27,7 +28,7 @@ This is a fork of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) which i * [Filesystem Options](#filesystem-options) * [Thumbnail images](#thumbnail-images) * [Internet Shortcut Options](#internet-shortcut-options) - * [Verbosity / Simulation Options](#verbosity--simulation-options) + * [Verbosity and Simulation Options](#verbosity-and-simulation-options) * [Workarounds](#workarounds) * [Video Format Options](#video-format-options) * [Subtitle Options](#subtitle-options) @@ -434,7 +435,7 @@ Then simply type this --write-webloc-link Write a .webloc macOS internet shortcut --write-desktop-link Write a .desktop Linux internet shortcut -## Verbosity / Simulation Options: +## Verbosity and Simulation Options: -q, --quiet Activate quiet mode --no-warnings Ignore warnings -s, --simulate Do not download the video and do not write diff --git a/docs/conf.py b/docs/conf.py index 58c0359e7..3fbf82f54 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ master_doc = 'index' # General information about the project. project = u'yt-dlp' +author = u'yt-dlp' copyright = u'UNLICENSE' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 9be67038a..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -Welcome to yt-dlp's documentation! -====================================== - -*yt-dlp* 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 *yt-dlp* from Python programs. - -.. toctree:: - :maxdepth: 2 - - module_guide - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/module_guide.rst b/docs/module_guide.rst deleted file mode 100644 index d6a96a9cf..000000000 --- a/docs/module_guide.rst +++ /dev/null @@ -1,66 +0,0 @@ -Using the ``yt_dlp`` module -=============================== - -When using the ``yt_dlp`` module, you start by creating an instance of :class:`YoutubeDL` and adding all the available extractors: - -.. code-block:: python - - >>> from yt_dlp import YoutubeDL - >>> ydl = YoutubeDL() - >>> ydl.add_default_info_extractors() - -Extracting video information ----------------------------- - -You use the :meth:`YoutubeDL.extract_info` method for getting the video information, which returns a dictionary: - -.. code-block:: python - - >>> info = ydl.extract_info('http://www.youtube.com/watch?v=BaW_jenozKc', download=False) - [youtube] Setting language - [youtube] BaW_jenozKc: Downloading webpage - [youtube] BaW_jenozKc: Downloading video info webpage - [youtube] BaW_jenozKc: Extracting video information - >>> info['title'] - 'youtube-dl test video "\'/\\ä↭𝕐' - >>> info['height'], info['width'] - (720, 1280) - -If you want to download or play the video you can get its url: - -.. code-block:: python - - >>> info['url'] - 'https://...' - -Extracting playlist information -------------------------------- - -The playlist information is extracted in a similar way, but the dictionary is a bit different: - -.. code-block:: python - - >>> playlist = ydl.extract_info('http://www.ted.com/playlists/13/open_source_open_world', download=False) - [TED] open_source_open_world: Downloading playlist webpage - ... - >>> playlist['title'] - 'Open-source, open world' - - - -You can access the videos in the playlist with the ``entries`` field: - -.. code-block:: python - - >>> for video in playlist['entries']: - ... print('Video #%d: %s' % (video['playlist_index'], video['title'])) - - Video #1: How Arduino is open-sourcing imagination - Video #2: The year open data went worldwide - Video #3: Massive-scale online collaboration - Video #4: The art of asking - Video #5: How cognitive surplus will change the world - Video #6: The birth of Wikipedia - Video #7: Coding a better government - Video #8: The era of open innovation - Video #9: The currency of the new economy is trust @@ -80,7 +80,7 @@ setup( packages=packages, install_requires=REQUIREMENTS, project_urls={ - 'Documentation': 'https://github.com/yt-dlp/yt-dlp#yt-dlp', + 'Documentation': 'https://yt-dlp.readthedocs.io', 'Source': 'https://github.com/yt-dlp/yt-dlp', 'Tracker': 'https://github.com/yt-dlp/yt-dlp/issues', #'Funding': 'https://donate.pypi.org', diff --git a/yt_dlp/options.py b/yt_dlp/options.py index 00bc02c2d..c47f6ea50 100644 --- a/yt_dlp/options.py +++ b/yt_dlp/options.py @@ -708,7 +708,7 @@ def parseOpts(overrideArguments=None): dest='sleep_interval_subtitles', default=0, type=int, help='Enforce sleep interval on subtitles as well') - verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options') + verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options') verbosity.add_option( '-q', '--quiet', action='store_true', dest='quiet', default=False, |