[documentation] Changes left behind from #85 and #107

diff --git a/README.md b/README.md
index ef1a7bba240c02f834e00dbe6b055d7177ff7797..f390531ac6b9dfb6576cda0a6497b3415f714460 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@ # YT-DLP
 [![Last Commit](https://img.shields.io/github/last-commit/yt-dlp/yt-dlp/master)](https://github.com/yt-dlp/yt-dlp/commits)
 [![Downloads](https://img.shields.io/github/downloads/yt-dlp/yt-dlp/total)](https://github.com/yt-dlp/yt-dlp/releases/latest)
 [![PyPi Downloads](https://img.shields.io/pypi/dm/yt-dlp?label=PyPi)](https://pypi.org/project/yt-dlp)
+[![Doc Status](https://readthedocs.org/projects/yt-dlp/badge/?version=latest)](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 @@ # YT-DLP
     * [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 @@ ## Internet Shortcut Options:
     --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 58c0359e739e3e801c4b639a52e275c1a09d1276..3fbf82f54f501c6834b9c1f4de4031c6f10fc081 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,6 +30,7 @@
 
 # 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 (file)
index 9be6703..0000000
--- 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 (file)
index d6a96a9..0000000
--- 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

diff --git a/setup.py b/setup.py
index c49b8edaf7209d9a730e4fdcd53596d17117d368..e5c9fec4c0bbc7bfa34f1818e805a9b7ded03b87 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -80,7 +80,7 @@ def run(self):
     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 00bc02c2d2fa2a09c58e12fee6e1e64d4520eba1..c47f6ea50a13bdb61235049535fa5eadcae8fe99 100644 (file)
--- a/yt_dlp/options.py
+++ b/yt_dlp/options.py
@@ -708,7 +708,7 @@ def _dict_from_multiple_values_options_callback(
         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,