diff options
author | Pccode66 <49125134+Pccode66@users.noreply.github.com> | 2021-02-24 15:45:56 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-25 00:15:56 +0530 |
commit | 7a5c1cfe93924351387b44919b3c0b2f66c4b883 (patch) | |
tree | 6da63f3d7b16cf7d4b9fdb29b029125cab8bd0d3 /docs | |
parent | c4218ac3f1146daac20308439cdc374e3561101a (diff) | |
download | hypervideo-pre-7a5c1cfe93924351387b44919b3c0b2f66c4b883.tar.lz hypervideo-pre-7a5c1cfe93924351387b44919b3c0b2f66c4b883.tar.xz hypervideo-pre-7a5c1cfe93924351387b44919b3c0b2f66c4b883.zip |
Completely change project name to yt-dlp (#85)
* All modules and binary names are changed
* All documentation references changed
* yt-dlp no longer loads youtube-dlc config files
* All URLs changed to point to organization account
Co-authored-by: Pccode66
Co-authored-by: pukkandan
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile | 8 | ||||
-rw-r--r-- | docs/conf.py | 14 | ||||
-rw-r--r-- | docs/index.rst | 23 | ||||
-rw-r--r-- | docs/module_guide.rst | 9 |
4 files changed, 33 insertions, 21 deletions
diff --git a/docs/Makefile b/docs/Makefile index a7159ff45..1a8e3cb1c 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-dlc.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yt-dlp.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/youtube-dlc.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yt-dlp.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-dlc" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/youtube-dlc" + @echo "# mkdir -p $$HOME/.local/share/devhelp/yt-dlp" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yt-dlp" @echo "# devhelp" epub: diff --git a/docs/conf.py b/docs/conf.py index 3ce98be4d..58c0359e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,16 +1,6 @@ # coding: utf-8 # -# 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 -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# yt-dlp documentation build configuration file import sys import os @@ -47,7 +37,7 @@ copyright = u'UNLICENSE' # built documents. # # The short X.Y version. -from youtube_dlc.version import __version__ +from yt_dlp.version import __version__ version = __version__ # The full version, including alpha/beta/rc tags. release = version diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..9be67038a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +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 index 6413659cf..d6a96a9cf 100644 --- a/docs/module_guide.rst +++ b/docs/module_guide.rst @@ -1,11 +1,11 @@ -Using the ``youtube_dlc`` module +Using the ``yt_dlp`` module =============================== -When using the ``youtube_dlc`` module, you start by creating an instance of :class:`YoutubeDL` and adding all the available extractors: +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 youtube_dlc import YoutubeDL + >>> from yt_dlp 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-dlc test video "\'/\\ä↭𝕐' + 'youtube-dl test video "\'/\\ä↭𝕐' >>> info['height'], info['width'] (720, 1280) @@ -64,4 +64,3 @@ You can access the videos in the playlist with the ``entries`` field: Video #7: Coding a better government Video #8: The era of open innovation Video #9: The currency of the new economy is trust - |