docs/conf.py

   1 # coding: utf-8
   2 #
   3 # yt-dlp documentation build configuration file
   4
   5 import sys
   6 import os
   7
   8 # Allows to import yt-dlp
   9 sys.path.insert(0, os.path.abspath('..'))
  10
  11 # -- General configuration ------------------------------------------------
  12
  13 # Add any Sphinx extension module names here, as strings. They can be
  14 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  15 # ones.
  16 extensions = [
  17     'myst_parser',
  18 ]
  19
  20 # Add any paths that contain templates here, relative to this directory.
  21 templates_path = ['_templates']
  22
  23 # The master toctree document.
  24 master_doc = 'README'
  25
  26 # General information about the project.
  27 project = u'yt-dlp'
  28 author = u'yt-dlp'
  29 copyright = u'UNLICENSE'
  30
  31 # The version info for the project you're documenting, acts as replacement for
  32 # |version| and |release|, also used in various other places throughout the
  33 # built documents.
  34 #
  35 # The short X.Y version.
  36 from yt_dlp.version import __version__
  37 version = __version__
  38 # The full version, including alpha/beta/rc tags.
  39 release = version
  40
  41 # List of patterns, relative to source directory, that match files and
  42 # directories to ignore when looking for source files.
  43 exclude_patterns = ['_build']
  44
  45 # The name of the Pygments (syntax highlighting) style to use.
  46 pygments_style = 'sphinx'
  47
  48 # -- Options for HTML output ----------------------------------------------
  49
  50 # The theme to use for HTML and HTML Help pages.  See the documentation for
  51 # a list of builtin themes.
  52 html_theme = 'default'
  53
  54 # Disable highlights
  55 highlight_language = 'none'
  56
  57 # Add any paths that contain custom static files (such as style sheets) here,
  58 # relative to this directory. They are copied after the builtin static files,
  59 # so a file named "default.css" will overwrite the builtin "default.css".
  60 # html_static_path = ['_static']
  61
  62 # Enable heading anchors
  63 myst_heading_anchors = 4
  64
  65 # Suppress heading warnings
  66 suppress_warnings = [
  67     'myst.header',
  68 ]