a758a8870d
Updates the configuration file's docs to be cleaner. Removes sphinx autodocs entirely in favor of our custom-built one.
70 lines
2 KiB
Python
70 lines
2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "ytdl-sub"
|
|
copyright = "2026, Jesse Bannon"
|
|
author = "Jesse Bannon"
|
|
release = ""
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.extlinks",
|
|
"sphinx_copybutton",
|
|
"sphinx_design",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_book_theme"
|
|
|
|
html_theme_options = {
|
|
"icon_links": [
|
|
{
|
|
"name": "GitHub",
|
|
"url": "https://github.com/jmbannon/ytdl-sub",
|
|
"icon": "fa-brands fa-square-github",
|
|
"type": "fontawesome",
|
|
},
|
|
{
|
|
"name": "Discord",
|
|
"url": "https://discord.gg/v8j9RAHb4k",
|
|
"icon": "https://img.shields.io/discord/994270357957648404?logo=Discord",
|
|
"type": "url",
|
|
},
|
|
],
|
|
"announcement": "",
|
|
"navigation_depth": 10,
|
|
"show_toc_level": 10,
|
|
}
|
|
|
|
html_static_path = ["_static"]
|
|
html_css_files = ["custom.css"]
|
|
|
|
|
|
# Make sure the all autosectionlabel targets are unique
|
|
autosectionlabel_prefix_document = True
|
|
|
|
suppress_warnings = [
|
|
"autosectionlabel.*",
|
|
]
|
|
|
|
extlinks = {
|
|
"yt-dlp": ("https://github.com/yt-dlp/yt-dlp/%s", "yt-dlp%s"),
|
|
"unraid": ("https://unraid.net/%s", "unraid%s"),
|
|
"lsio": ("https://www.linuxserver.io/%s", "lsio%s"),
|
|
"lsio-gh": ("https://github.com/linuxserver/%s", "%s image"),
|
|
"ytdl-sub-gh": ("https://github.com/jmbannon/ytdl-sub/%s", "src %s"),
|
|
}
|