Completely change project name to yt-dlp (#85)

[yt-dlp.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 594ca61a6bf984d173620a3e95eaca28b22cda5a..58c0359e739e3e801c4b639a52e275c1a09d1276 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,50 +1,43 @@
-# -*- coding: utf-8 -*-
+# coding: utf-8
 #
-# youtube-dl 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
-# Allows to import youtube_dl
-sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+# Allows to import yt-dlp
+sys.path.insert(0, os.path.abspath('..'))
+from recommonmark.transform import AutoStructify
 
 # -- General configuration ------------------------------------------------
 
+# The suffix of source filenames.
+source_suffix = ['.rst', '.md']
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'recommonmark',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The suffix of source filenames.
-source_suffix = '.rst'
-
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'youtube-dl'
-copyright = u'2014, Ricardo Garcia Gonzalez'
+project = u'yt-dlp'
+copyright = u'UNLICENSE'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-from youtube_dl.version import __version__
+from yt_dlp.version import __version__
 version = __version__
 # The full version, including alpha/beta/rc tags.
 release = version
@@ -62,10 +55,20 @@
 # a list of builtin themes.
 html_theme = 'default'
 
+# Disable highlights
+highlight_language = 'none'
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
+
 
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'youtube-dldoc'
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'enable_math': False,
+        'enable_inline_math': False,
+        'enable_eval_rst': True,
+        'enable_auto_toc_tree': True,
+    }, True)
+    app.add_transform(AutoStructify)