diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 8 | ||||
| -rw-r--r-- | docs/conf.py | 10 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/module_guide.rst | 8 |
4 files changed, 16 insertions, 16 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/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) |