diff options
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 45 |
1 files changed, 21 insertions, 24 deletions
diff --git a/docs/conf.py b/docs/conf.py index 0aaf1b8fc..c4010bbc7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,21 +1,12 @@ # 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('..')) # -- General configuration ------------------------------------------------ @@ -23,28 +14,26 @@ sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', + 'myst_parser', ] # 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' +master_doc = 'README' # General information about the project. -project = u'youtube-dl' -copyright = u'2014, Ricardo Garcia Gonzalez' +project = u'yt-dlp' +author = 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 +51,18 @@ pygments_style = 'sphinx' # 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' +# Enable heading anchors +myst_heading_anchors = 4 + +# Suppress heading warnings +suppress_warnings = [ + 'myst.header', +] |