]>
jfr.im git - yt-dlp.git/blob - docs/conf.py
3 # yt-dlp documentation build configuration file
8 # Allows to import yt-dlp
9 sys
.path
.insert(0, os
.path
.abspath('..'))
11 # -- General configuration ------------------------------------------------
13 # Add any Sphinx extension module names here, as strings. They can be
14 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
20 # Add any paths that contain templates here, relative to this directory.
21 templates_path
= ['_templates']
23 # The master toctree document.
26 # General information about the project.
29 copyright
= u
'UNLICENSE'
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
35 # The short X.Y version.
36 from yt_dlp
.version
import __version__
38 # The full version, including alpha/beta/rc tags.
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']
45 # The name of the Pygments (syntax highlighting) style to use.
46 pygments_style
= 'sphinx'
48 # -- Options for HTML output ----------------------------------------------
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'
55 highlight_language
= 'none'
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']
62 # Enable heading anchors
63 myst_heading_anchors
= 4
65 # Suppress heading warnings