2022-03-08 08:06:22 +00:00
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
|
#
|
|
|
|
|
# This file only contains a selection of the most common options. For a full
|
|
|
|
|
# list see the documentation:
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
import datetime
|
|
|
|
|
import sys
|
|
|
|
|
from os.path import abspath, dirname
|
|
|
|
|
|
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
|
#
|
|
|
|
|
# import os
|
|
|
|
|
import sphinx_bootstrap_theme
|
|
|
|
|
|
|
|
|
|
path = dirname(abspath(__file__))
|
|
|
|
|
sys.path.append(path)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
|
|
project = "Plex Meta Manager Wiki"
|
|
|
|
|
author = "Nathan Taggart"
|
|
|
|
|
copyright = f"{datetime.datetime.now().year}"
|
|
|
|
|
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
2022-03-08 08:07:59 +00:00
|
|
|
with open("../VERSION") as f:
|
2022-03-08 08:06:22 +00:00
|
|
|
release = f.readline()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# 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',
|
|
|
|
|
'sphinx.ext.coverage',
|
|
|
|
|
'sphinx.ext.viewcode',
|
|
|
|
|
'sphinx.ext.napoleon',
|
|
|
|
|
'sphinx.ext.todo',
|
|
|
|
|
'myst_parser',
|
2022-03-09 23:59:31 +00:00
|
|
|
'sphinx_inline_tabs',
|
2022-06-20 18:33:27 +00:00
|
|
|
'sphinx_copybutton',
|
2023-01-24 20:06:33 +00:00
|
|
|
'sphinx_reredirects',
|
2023-02-15 07:37:44 +00:00
|
|
|
'sphinx_design',
|
|
|
|
|
'notfound.extension'
|
2022-03-08 08:06:22 +00:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
|
myst_heading_anchors = 4
|
2023-01-24 20:06:33 +00:00
|
|
|
myst_enable_extensions = ["colon_fence"]
|
2022-03-08 08:06:22 +00:00
|
|
|
|
|
|
|
|
# -- Napoleon Settings -----------------------------------------------------
|
|
|
|
|
napoleon_google_docstring = True
|
|
|
|
|
napoleon_numpy_docstring = False
|
|
|
|
|
napoleon_include_init_with_doc = False
|
|
|
|
|
napoleon_include_private_with_doc = False
|
|
|
|
|
napoleon_include_special_with_doc = False
|
|
|
|
|
napoleon_use_admonition_for_examples = False
|
|
|
|
|
napoleon_use_admonition_for_notes = False
|
|
|
|
|
napoleon_use_admonition_for_references = False
|
|
|
|
|
napoleon_use_ivar = True
|
|
|
|
|
napoleon_use_param = True
|
|
|
|
|
napoleon_use_rtype = True
|
|
|
|
|
napoleon_use_keyword = True
|
|
|
|
|
autodoc_member_order = 'bysource'
|
|
|
|
|
add_module_names = False
|
|
|
|
|
|
|
|
|
|
master_doc = 'index'
|
|
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
|
# a list of builtin themes.
|
|
|
|
|
#
|
|
|
|
|
# html_theme = "nature"
|
|
|
|
|
html_theme = "bootstrap"
|
|
|
|
|
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
|
|
|
|
|
# (Optional) Logo. Should be small enough to fit the navbar (ideally 24x24).
|
|
|
|
|
# Path should be relative to the ``_static`` files directory.
|
2022-05-25 18:42:24 +00:00
|
|
|
html_logo = "_static/logo-white.png"
|
|
|
|
|
html_favicon = "_static/favicon.png"
|
2022-03-08 08:06:22 +00:00
|
|
|
|
|
|
|
|
html_copy_source = False
|
|
|
|
|
html_show_sourcelink = False
|
|
|
|
|
|
2022-06-20 18:33:27 +00:00
|
|
|
# Redirect URLs
|
|
|
|
|
# "<source>": "<target>"
|
|
|
|
|
redirects = {
|
2022-10-29 15:59:01 +00:00
|
|
|
"redact": "https://regex101.com/r/DMo1DQ/latest",
|
2022-10-29 18:42:05 +00:00
|
|
|
"home/guides/alternative-docker": "images.html",
|
2022-11-03 19:44:01 +00:00
|
|
|
"home/guides/defaults": "../../defaults/guide.html",
|
|
|
|
|
"metadata/details/setting": "definition.html",
|
|
|
|
|
"metadata/details/details": "update.html",
|
2023-02-17 16:11:08 +00:00
|
|
|
"malauth": "https://replit.com/@chazlarson/MALAuth",
|
|
|
|
|
"traktauth": "https://replit.com/@chazlarson/TraktAuth",
|
2023-02-17 17:04:16 +00:00
|
|
|
"defaults/movie/universe": "../../both/universe.html",
|
2023-02-19 20:24:27 +00:00
|
|
|
"discord": "https://discord.gg/FNqqw5jRSz",
|
2022-06-20 18:33:27 +00:00
|
|
|
}
|
|
|
|
|
|
2022-03-08 08:06:22 +00:00
|
|
|
# Theme options are theme-specific and customize the look and feel of a
|
|
|
|
|
# theme further.
|
|
|
|
|
|
|
|
|
|
html_theme_options = {
|
|
|
|
|
# Tab name for entire site. (Default: "Site")
|
|
|
|
|
'navbar_site_name': "Table of Contents",
|
|
|
|
|
|
|
|
|
|
# A list of tuples containing pages or urls to link to.
|
|
|
|
|
# Valid tuples should be in the following forms:
|
|
|
|
|
# (name, page) # a link to a page
|
|
|
|
|
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
|
|
|
|
|
# (name, "http://example.com", True) # arbitrary absolute url
|
|
|
|
|
# Note the "1" or "True" value above as the third argument to indicate
|
|
|
|
|
# an arbitrary url.
|
|
|
|
|
'navbar_links': [
|
|
|
|
|
("_menu", "Essentials", [
|
|
|
|
|
("Plex Meta Manager", "index"),
|
|
|
|
|
("_divider", ),
|
2022-10-17 06:48:08 +00:00
|
|
|
("_menu", "Installation", "home/installation", [
|
2022-03-08 08:06:22 +00:00
|
|
|
("Installing Plex Meta Manager", "home/installation"),
|
|
|
|
|
("_divider", ),
|
|
|
|
|
("Local Walkthrough", "home/guides/local"),
|
|
|
|
|
("Docker Walkthrough", "home/guides/docker"),
|
2022-10-29 15:59:01 +00:00
|
|
|
("Docker Images", "home/guides/images"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("_divider", ),
|
2022-03-08 08:06:22 +00:00
|
|
|
("unRAID Walkthrough", "home/guides/unraid"),
|
|
|
|
|
("Kubernetes Walkthrough", "home/guides/kubernetes"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("QNAP Walkthrough", "home/guides/qnap"),
|
|
|
|
|
("Synology Walkthrough", "home/guides/synology"),
|
2022-03-08 08:06:22 +00:00
|
|
|
]),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Log Files", "home/logs"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("Run Commands & Environment Variables", "home/environmental"),
|
2022-07-21 21:01:53 +00:00
|
|
|
("Knowledgebase/FAQ", "home/kb"),
|
2023-02-22 22:01:29 +00:00
|
|
|
("_menu", "Companion Scripts", "home/scripts", [
|
|
|
|
|
("Companion Scripts", "home/scripts"),
|
|
|
|
|
("_divider", ),
|
|
|
|
|
("PMM Overlay Reset", "home/scripts/overlay-reset"),
|
|
|
|
|
("Plex Image Cleanup", "home/scripts/image-cleanup"),
|
|
|
|
|
]),
|
2022-03-08 08:06:22 +00:00
|
|
|
("_divider", ),
|
2022-11-03 19:44:01 +00:00
|
|
|
("YAML File Guide", "home/guides/yaml"),
|
2023-02-28 19:59:47 +00:00
|
|
|
("Ratings Explained", "home/guides/ratings"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("Scheduling Guide", "home/guides/scheduling"),
|
|
|
|
|
("Image Asset Directory Guide", "home/guides/assets"),
|
2022-04-01 06:39:23 +00:00
|
|
|
("Formula 1 Metadata Guide", "home/guides/formula"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("_divider", ),
|
2022-12-22 20:40:10 +00:00
|
|
|
("Feature Requests", "https://features.metamanager.wiki/"),
|
|
|
|
|
("Bugs/Issues", "https://github.com/meisnate12/Plex-Meta-Manager/issues"),
|
2022-11-11 15:57:36 +00:00
|
|
|
("User Configs Repository", "https://github.com/meisnate12/Plex-Meta-Manager-Configs"),
|
2023-05-17 18:25:01 +00:00
|
|
|
("Discord Server", "https://discord.gg/plexmetamanager"),
|
2022-11-11 15:57:36 +00:00
|
|
|
("Donate/Sponsor", "https://github.com/sponsors/meisnate12"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("Acknowledgements", "home/acknowledgements"),
|
|
|
|
|
]),
|
|
|
|
|
("_menu", "Config", [
|
2022-10-29 15:59:01 +00:00
|
|
|
("Config File", "config/configuration"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("_divider", ),
|
2022-10-29 15:59:01 +00:00
|
|
|
("Libraries", "config/libraries"),
|
|
|
|
|
("Playlists", "config/playlists"),
|
2022-04-10 04:33:59 +00:00
|
|
|
("Path Types", "config/paths"),
|
2022-10-29 15:59:01 +00:00
|
|
|
("_menu", "Library Operations", "config/operations", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Assets For All", "config/operations", "#assets-for-all"),
|
2022-11-15 07:56:31 +00:00
|
|
|
("Delete Collections", "config/operations", "#delete-collections"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("Mass Genre Update", "config/operations", "#mass-genre-update"),
|
|
|
|
|
("Mass Content Rating Update", "config/operations", "#mass-content-rating-update"),
|
|
|
|
|
("Mass Original Title Update", "config/operations", "#mass-original-title-update"),
|
2023-04-05 15:58:46 +00:00
|
|
|
("Mass Studio Update", "config/operations", "#mass-studio-update"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("Mass Originally Available Update", "config/operations", "#mass-originally-available-update"),
|
|
|
|
|
("Mass * Rating Update", "config/operations", "#mass--rating-update"),
|
|
|
|
|
("Mass Episode * Rating Update", "config/operations", "#mass-episode--rating-update"),
|
2022-10-26 06:57:39 +00:00
|
|
|
("Mass Poster Update", "config/operations", "#mass-poster-update"),
|
|
|
|
|
("Mass Background Update", "config/operations", "#mass-background-update"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("Mass IMDb Parental Labels", "config/operations", "#mass-imdb-parental-labels"),
|
|
|
|
|
("Mass Collection Mode", "config/operations", "#mass-collection-mode"),
|
|
|
|
|
("Update Blank Track Titles", "config/operations", "#update-blank-track-titles"),
|
|
|
|
|
("Remove Title Parentheses", "config/operations", "#remove-title-parentheses"),
|
|
|
|
|
("Split Duplicates", "config/operations", "#split-duplicates"),
|
|
|
|
|
("Radarr Add All", "config/operations", "#radarr-add-all"),
|
|
|
|
|
("Radarr Remove By Tag", "config/operations", "#radarr-remove-by-tag"),
|
|
|
|
|
("Sonarr Add All", "config/operations", "#sonarr-add-all"),
|
|
|
|
|
("Sonarr Remove By Tag", "config/operations", "#sonarr-remove-by-tag"),
|
|
|
|
|
("Genre Mapper", "config/operations", "#genre-mapper"),
|
|
|
|
|
("Content Rating Mapper", "config/operations", "#content-rating-mapper"),
|
|
|
|
|
("Metadata Backup", "config/operations", "#metadata-backup"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
2022-04-10 04:33:59 +00:00
|
|
|
("Settings", "config/settings"),
|
2022-04-10 05:48:23 +00:00
|
|
|
("Webhooks", "config/webhooks"),
|
|
|
|
|
("_divider", ),
|
|
|
|
|
("Plex", "config/plex"),
|
|
|
|
|
("Tautulli", "config/tautulli"),
|
|
|
|
|
("Radarr", "config/radarr"),
|
|
|
|
|
("Sonarr", "config/sonarr"),
|
2022-10-29 15:59:01 +00:00
|
|
|
("Notifiarr", "config/notifiarr"),
|
2022-04-10 05:48:23 +00:00
|
|
|
("_divider", ),
|
|
|
|
|
("TMDb", "config/tmdb"),
|
|
|
|
|
("Trakt", "config/trakt"),
|
|
|
|
|
("MdbList", "config/mdblist"),
|
|
|
|
|
("OMDb", "config/omdb"),
|
|
|
|
|
("AniDB", "config/anidb"),
|
|
|
|
|
("MyAnimeList", "config/myanimelist"),
|
2022-03-08 08:06:22 +00:00
|
|
|
]),
|
2022-09-27 06:19:29 +00:00
|
|
|
("_menu", "Defaults", [
|
2022-10-17 06:48:08 +00:00
|
|
|
("Defaults Usage Guide", "defaults/guide"),
|
|
|
|
|
("Defaults Files", "defaults/files"),
|
2022-09-27 06:19:29 +00:00
|
|
|
("_divider", ),
|
2022-11-08 03:02:07 +00:00
|
|
|
("_menu", "Collections", "defaults/collections", [
|
|
|
|
|
("Collections", "defaults/collections"),
|
|
|
|
|
("Shared Variables", "defaults/collection_variables"),
|
2022-09-27 06:19:29 +00:00
|
|
|
("_divider", ),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Separators", "defaults/separators"),
|
2023-03-01 15:14:20 +00:00
|
|
|
("_menu", "Award", "defaults/collections", "#award-collections", [
|
2022-10-17 06:48:08 +00:00
|
|
|
("Awards Separator", "defaults/award/separator"),
|
|
|
|
|
("_divider",),
|
|
|
|
|
("Academy Awards (Oscars)", "defaults/award/oscars"),
|
|
|
|
|
("British Academy of Film Awards", "defaults/award/bafta"),
|
2023-01-17 02:26:29 +00:00
|
|
|
("Cannes Film Festival Awards", "defaults/award/cannes"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Critics Choice Awards", "defaults/award/choice"),
|
|
|
|
|
("Emmy Awards", "defaults/award/emmy"),
|
|
|
|
|
("Golden Globe Awards", "defaults/award/golden"),
|
|
|
|
|
("Independent Spirit Awards", "defaults/award/spirit"),
|
2023-01-17 02:26:29 +00:00
|
|
|
("Sundance Film Festival Awards", "defaults/award/sundance"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Other Awards", "defaults/award/other"),
|
|
|
|
|
]),
|
2023-03-01 15:14:20 +00:00
|
|
|
("_menu", "Chart", "defaults/collections", "#chart-collections", [
|
2022-10-17 06:48:08 +00:00
|
|
|
("Chart Separator", "defaults/chart/separator"),
|
|
|
|
|
("_divider",),
|
|
|
|
|
("Basic Charts", "defaults/chart/basic"),
|
|
|
|
|
("AniList Charts", "defaults/chart/anilist"),
|
|
|
|
|
("Flixpatrol Charts", "defaults/chart/flixpatrol"),
|
|
|
|
|
("IMDb Charts", "defaults/chart/imdb"),
|
|
|
|
|
("MyAnimeList Charts", "defaults/chart/myanimelist"),
|
|
|
|
|
("Tautulli Charts", "defaults/chart/tautulli"),
|
|
|
|
|
("TMDb Charts", "defaults/chart/tmdb"),
|
|
|
|
|
("Trakt Charts", "defaults/chart/trakt"),
|
|
|
|
|
("Other Charts", "defaults/chart/other"),
|
|
|
|
|
]),
|
2023-03-01 15:14:20 +00:00
|
|
|
("_menu", "Movie", "defaults/collections", "#general-collections", [
|
2022-10-17 06:48:08 +00:00
|
|
|
("Actors", "defaults/both/actor"),
|
|
|
|
|
("Audio Languages", "defaults/both/audio_language"),
|
2023-01-27 17:05:31 +00:00
|
|
|
("Based On...", "defaults/both/based"),
|
2022-10-25 19:47:45 +00:00
|
|
|
("Collectionless", "defaults/both/collectionless"),
|
2022-10-25 14:59:35 +00:00
|
|
|
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
|
|
|
|
|
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Content Ratings (US)", "defaults/movie/content_rating_us"),
|
|
|
|
|
("Content Ratings (UK)", "defaults/both/content_rating_uk"),
|
|
|
|
|
("Countries", "defaults/movie/country"),
|
|
|
|
|
("Decades", "defaults/movie/decade"),
|
|
|
|
|
("Directors", "defaults/movie/director"),
|
|
|
|
|
("Franchises", "defaults/movie/franchise"),
|
|
|
|
|
("Genres", "defaults/both/genre"),
|
|
|
|
|
("Producers", "defaults/movie/producer"),
|
|
|
|
|
("Resolutions", "defaults/both/resolution"),
|
|
|
|
|
("Seasonal", "defaults/movie/seasonal"),
|
|
|
|
|
("Streaming", "defaults/both/streaming"),
|
|
|
|
|
("Studios", "defaults/both/studio"),
|
2022-10-25 14:59:35 +00:00
|
|
|
("Anime Studios", "defaults/both/studio_anime"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Subtitle Languages", "defaults/both/subtitle_language"),
|
2023-02-17 16:06:12 +00:00
|
|
|
("Universes", "defaults/both/universe"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Writers", "defaults/movie/writer"),
|
|
|
|
|
("Years", "defaults/both/year"),
|
|
|
|
|
]),
|
2023-03-01 15:14:20 +00:00
|
|
|
("_menu", "Show", "defaults/collections", "#general-collections", [
|
2022-10-17 06:48:08 +00:00
|
|
|
("Actors", "defaults/both/actor"),
|
|
|
|
|
("Audio Languages", "defaults/both/audio_language"),
|
2023-01-27 17:05:31 +00:00
|
|
|
("Based On...", "defaults/both/based"),
|
2022-10-25 19:47:45 +00:00
|
|
|
("Collectionless", "defaults/both/collectionless"),
|
2022-10-18 20:54:28 +00:00
|
|
|
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
|
2022-10-25 14:59:35 +00:00
|
|
|
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
|
2022-10-18 20:54:28 +00:00
|
|
|
("US Content Ratings", "defaults/show/content_rating_us"),
|
|
|
|
|
("UK Content Ratings", "defaults/both/content_rating_uk"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Countries", "defaults/show/country"),
|
|
|
|
|
("Decades", "defaults/show/decade"),
|
|
|
|
|
("Franchises", "defaults/show/franchise"),
|
|
|
|
|
("Genres", "defaults/both/genre"),
|
|
|
|
|
("Networks", "defaults/show/network"),
|
|
|
|
|
("Resolutions", "defaults/both/resolution"),
|
|
|
|
|
("Streaming", "defaults/both/streaming"),
|
|
|
|
|
("Studios", "defaults/both/studio"),
|
2022-10-25 14:59:35 +00:00
|
|
|
("Anime Studios", "defaults/both/studio_anime"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Subtitle Languages", "defaults/both/subtitle_language"),
|
2023-02-17 16:12:50 +00:00
|
|
|
("Universes", "defaults/both/universe"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Years", "defaults/both/year"),
|
|
|
|
|
]),
|
2022-09-27 06:19:29 +00:00
|
|
|
]),
|
2022-10-13 21:02:05 +00:00
|
|
|
("Playlists", "defaults/playlist"),
|
2022-11-08 03:02:07 +00:00
|
|
|
("_menu", "Overlays", "defaults/overlays", [
|
|
|
|
|
("Overlays", "defaults/overlays"),
|
|
|
|
|
("Shared Variables", "defaults/overlay_variables"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("_divider", ),
|
|
|
|
|
("Audio Codec", "defaults/overlays/audio_codec"),
|
|
|
|
|
("Common Sense Age Ratings", "defaults/overlays/commonsense"),
|
2023-04-27 19:24:56 +00:00
|
|
|
("Content Ratings (UK)", "defaults/overlays/content_rating_uk"),
|
|
|
|
|
("Content Ratings (US Movie)", "defaults/overlays/content_rating_us_movie"),
|
|
|
|
|
("Content Ratings (US Show)", "defaults/overlays/content_rating_us_show"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Direct Play Only", "defaults/overlays/direct_play"),
|
|
|
|
|
("Episode Info", "defaults/overlays/episode_info"),
|
2022-10-18 03:30:22 +00:00
|
|
|
("FlixPatrol Top", "defaults/overlays/flixpatrol"),
|
2022-10-27 06:39:30 +00:00
|
|
|
("Audio/Subtitle Language Count", "defaults/overlays/language_count"),
|
|
|
|
|
("Audio/Subtitle Language Flags", "defaults/overlays/languages"),
|
2022-10-24 21:01:58 +00:00
|
|
|
("Languages", "defaults/overlays/languages"),
|
2022-10-17 07:11:40 +00:00
|
|
|
("MediaStinger", "defaults/overlays/mediastinger"),
|
2023-04-18 19:58:22 +00:00
|
|
|
("Networks", "defaults/overlays/network"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Ratings", "defaults/overlays/ratings"),
|
2022-10-17 07:11:40 +00:00
|
|
|
("Resolution/Edition", "defaults/overlays/resolution"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Ribbon", "defaults/overlays/ribbon"),
|
|
|
|
|
("Runtimes", "defaults/overlays/runtimes"),
|
2022-10-17 07:11:40 +00:00
|
|
|
("Status", "defaults/overlays/status"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Streaming", "defaults/overlays/streaming"),
|
2023-05-20 17:58:17 +00:00
|
|
|
("Studios", "defaults/overlays/studio"),
|
2022-10-17 06:48:08 +00:00
|
|
|
("Versions", "defaults/overlays/versions"),
|
|
|
|
|
("Video Format", "defaults/overlays/video_format"),
|
2022-09-27 06:19:29 +00:00
|
|
|
]),
|
|
|
|
|
]),
|
|
|
|
|
("_menu", "Files", [
|
2022-04-18 18:16:39 +00:00
|
|
|
("Metadata Files", "metadata/metadata"),
|
|
|
|
|
("Overlay Files", "metadata/overlay"),
|
|
|
|
|
("Playlist Files", "metadata/playlist"),
|
2022-03-08 08:06:22 +00:00
|
|
|
("_divider", ),
|
|
|
|
|
("Templates", "metadata/templates"),
|
|
|
|
|
("Filters", "metadata/filters"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("_menu", "Dynamic Collections", "metadata/dynamic", [
|
2022-12-02 17:08:01 +00:00
|
|
|
("Dynamic Collections", "metadata/dynamic"),
|
|
|
|
|
("_divider", ),
|
2022-10-17 14:00:48 +00:00
|
|
|
("_menu", "TMDb Dynamic Collections", "metadata/dynamic", [
|
|
|
|
|
("TMDb Collection", "metadata/dynamic", "#tmdb-collection"),
|
|
|
|
|
("TMDb Popular People", "metadata/dynamic", "#tmdb-popular-people"),
|
|
|
|
|
("Original Language", "metadata/dynamic", "#original-language"),
|
|
|
|
|
("Origin Country", "metadata/dynamic", "#origin-country"),
|
|
|
|
|
]),
|
|
|
|
|
("_menu", "Trakt Dynamic Collections", "metadata/dynamic", [
|
|
|
|
|
("Trakt User Lists", "metadata/dynamic", "#trakt-user-lists"),
|
|
|
|
|
("Trakt Liked Lists", "metadata/dynamic", "#trakt-liked-lists"),
|
|
|
|
|
("Trakt People Lists", "metadata/dynamic", "#trakt-people-lists"),
|
|
|
|
|
]),
|
|
|
|
|
("_menu", "Plex Dynamic Collections", "metadata/dynamic", [
|
|
|
|
|
("Actor", "metadata/dynamic", "#actor"),
|
|
|
|
|
("Director", "metadata/dynamic", "#director"),
|
|
|
|
|
("Writer", "metadata/dynamic", "#writer"),
|
|
|
|
|
("Producer", "metadata/dynamic", "#producer"),
|
|
|
|
|
("Genre", "metadata/dynamic", "#genre"),
|
2022-12-02 17:08:01 +00:00
|
|
|
("Album Genre", "metadata/dynamic", "#album-genre"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("Content Rating", "metadata/dynamic", "#content-rating"),
|
|
|
|
|
("Year", "metadata/dynamic", "#year"),
|
|
|
|
|
("Decade", "metadata/dynamic", "#decade"),
|
|
|
|
|
("Country", "metadata/dynamic", "#country"),
|
|
|
|
|
("Resolution", "metadata/dynamic", "#resolution"),
|
|
|
|
|
("Subtitle Language", "metadata/dynamic", "#subtitle-language"),
|
|
|
|
|
("Audio Language", "metadata/dynamic", "#audio-language"),
|
|
|
|
|
("Studio", "metadata/dynamic", "#studio"),
|
|
|
|
|
("Edition", "metadata/dynamic", "#edition"),
|
|
|
|
|
("Network", "metadata/dynamic", "#network"),
|
|
|
|
|
("Mood", "metadata/dynamic", "#mood"),
|
2022-12-02 17:08:01 +00:00
|
|
|
("Album Mood", "metadata/dynamic", "#album-mood"),
|
|
|
|
|
("Track Mood", "metadata/dynamic", "#track-mood"),
|
2022-10-17 14:00:48 +00:00
|
|
|
("Style", "metadata/dynamic", "#style"),
|
|
|
|
|
("Album Style", "metadata/dynamic", "#album-style"),
|
|
|
|
|
]),
|
|
|
|
|
("Number", "metadata/dynamic", "#number"),
|
|
|
|
|
("Custom", "metadata/dynamic", "#custom"),
|
|
|
|
|
]),
|
2022-12-02 17:08:01 +00:00
|
|
|
("_menu", "Editing Media Metadata", "", [
|
2022-03-08 08:06:22 +00:00
|
|
|
("Editing Movie Metadata", "metadata/metadata/movie"),
|
|
|
|
|
("Editing TV Metadata", "metadata/metadata/show"),
|
|
|
|
|
("Editing Music Metadata", "metadata/metadata/music"),
|
|
|
|
|
]),
|
2022-11-03 19:44:01 +00:00
|
|
|
("_menu", "Builders", "metadata/builders", [
|
|
|
|
|
("Builders", "metadata/builders"),
|
|
|
|
|
("_divider", ),
|
2022-10-17 06:48:08 +00:00
|
|
|
("_menu", "Plex Builders", "metadata/builders/plex", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Plex All", "metadata/builders/plex", "#plex-all"),
|
|
|
|
|
("Plex Watchlist", "metadata/builders/plex", "#plex-watchlist"),
|
|
|
|
|
("Plex Pilots", "metadata/builders/plex", "#plex-pilots"),
|
|
|
|
|
("Plex Collectionless", "metadata/builders/plex", "#plex-collectionless"),
|
|
|
|
|
("Plex Search", "metadata/builders/plex", "#plex-search"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Smart Builders", "metadata/builders/smart", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Smart Label", "metadata/builders/smart", "#smart-label"),
|
|
|
|
|
("Smart Filter", "metadata/builders/smart", "#smart-filter"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "TMDb Builders", "metadata/builders/tmdb", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("TMDb Collection", "metadata/builders/tmdb", "#tmdb-collection"),
|
|
|
|
|
("TMDb List", "metadata/builders/tmdb", "#tmdb-list"),
|
|
|
|
|
("TMDb Actor", "metadata/builders/tmdb", "#tmdb-actor"),
|
|
|
|
|
("TMDb Crew", "metadata/builders/tmdb", "#tmdb-crew"),
|
|
|
|
|
("TMDb Director", "metadata/builders/tmdb", "#tmdb-director"),
|
|
|
|
|
("TMDb Producer", "metadata/builders/tmdb", "#tmdb-producer"),
|
|
|
|
|
("TMDb Writer", "metadata/builders/tmdb", "#tmdb-writer"),
|
|
|
|
|
("TMDb Movie", "metadata/builders/tmdb", "#tmdb-movie"),
|
|
|
|
|
("TMDb Show", "metadata/builders/tmdb", "#tmdb-show"),
|
|
|
|
|
("TMDb Company", "metadata/builders/tmdb", "#tmdb-company"),
|
|
|
|
|
("TMDb Network", "metadata/builders/tmdb", "#tmdb-network"),
|
|
|
|
|
("TMDb Keyword", "metadata/builders/tmdb", "#tmdb-keyword"),
|
|
|
|
|
("TMDb Popular", "metadata/builders/tmdb", "#tmdb-popular"),
|
|
|
|
|
("TMDb Now Playing", "metadata/builders/tmdb", "#tmdb-now-playing"),
|
|
|
|
|
("TMDb Top Rated", "metadata/builders/tmdb", "#tmdb-top-rated"),
|
|
|
|
|
("TMDb Upcoming", "metadata/builders/tmdb", "#tmdb-upcoming"),
|
|
|
|
|
("TMDb Airing Today", "metadata/builders/tmdb", "#tmdb-airing-today"),
|
|
|
|
|
("TMDb On the Air", "metadata/builders/tmdb", "#tmdb-on-the-air"),
|
|
|
|
|
("TMDb Trending Daily", "metadata/builders/tmdb", "#tmdb-trending-daily"),
|
|
|
|
|
("TMDb Trending Weekly", "metadata/builders/tmdb", "#tmdb-trending-weekly"),
|
|
|
|
|
("TMDb Discover", "metadata/builders/tmdb", "#tmdb-discover"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "TVDb Builders", "metadata/builders/tvdb", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("TVDb List", "metadata/builders/tvdb", "#tvdb-list"),
|
|
|
|
|
("TVDb Movie", "metadata/builders/tvdb", "#tvdb-movie"),
|
|
|
|
|
("TVDb Show", "metadata/builders/tvdb", "#tvdb-show"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "IMDb Builders", "metadata/builders/imdb", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("IMDb ID", "metadata/builders/imdb", "#imdb-id"),
|
|
|
|
|
("IMDb Chart", "metadata/builders/imdb", "#imdb-chart"),
|
|
|
|
|
("IMDb List", "metadata/builders/imdb", "#imdb-list"),
|
|
|
|
|
("IMDb Watchlist", "metadata/builders/imdb", "#imdb-watchlist"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Trakt Builders", "metadata/builders/trakt", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Trakt List", "metadata/builders/trakt", "#trakt-list"),
|
|
|
|
|
("Trakt Chart", "metadata/builders/trakt", "#trakt-chart"),
|
|
|
|
|
("Trakt Userlist", "metadata/builders/trakt", "#trakt-userlist"),
|
|
|
|
|
("Trakt Recommendations", "metadata/builders/trakt", "#trakt-recommendations"),
|
|
|
|
|
("Trakt Box Office", "metadata/builders/trakt", "#trakt-box-office"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Tautulli Builders", "metadata/builders/tautulli", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Tautulli Popular/Watched", "metadata/builders/tautulli", "#tautulli-popular-watched"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Radarr Builders", "metadata/builders/radarr", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Radarr All", "metadata/builders/radarr", "#radarr-all"),
|
|
|
|
|
("Radarr Taglist", "metadata/builders/radarr", "#radarr-taglist"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Sonarr Builders", "metadata/builders/sonarr", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Sonarr All", "metadata/builders/sonarr", "#sonarr-all"),
|
|
|
|
|
("Sonarr Taglist", "metadata/builders/sonarr", "#sonarr-taglist"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "MdbList Builders", "metadata/builders/mdblist", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("MdbList List", "metadata/builders/mdblist", "#mdblist-list"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Letterboxd Builders", "metadata/builders/letterboxd", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Letterboxd List", "metadata/builders/letterboxd", "#letterboxd-list"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "ICheckMovies Builders", "metadata/builders/icheckmovies", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("ICheckMovies List", "metadata/builders/icheckmovies", "#icheckmovies-list"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "FlixPatrol Builders", "metadata/builders/flixpatrol", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("FlixPatrol Top Platform", "metadata/builders/flixpatrol", "#flixpatrol-top"),
|
|
|
|
|
("FlixPatrol Popular", "metadata/builders/flixpatrol", "#flixpatrol-popular"),
|
2022-10-17 16:06:32 +00:00
|
|
|
("FlixPatrol Demographics", "metadata/builders/flixpatrol", "#flixpatrol-demographics"),
|
|
|
|
|
("FlixPatrol URL", "metadata/builders/flixpatrol", "#flixpatrol-url"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "Reciperr Builders", "metadata/builders/reciperr", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("Reciperr List", "metadata/builders/reciperr", "#reciperr-list"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "StevenLu Builders", "metadata/builders/stevenlu", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("StevenLu List", "metadata/builders/stevenlu", "#stevenlu-s-popular-movies-list"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "AniDB Builders", "metadata/builders/anidb", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("AniDB ID", "metadata/builders/anidb", "#anidb-id"),
|
|
|
|
|
("AniDB Relation", "metadata/builders/anidb", "#anidb-relation"),
|
|
|
|
|
("AniDB Popular", "metadata/builders/anidb", "#anidb-popular"),
|
|
|
|
|
("AniDB Tag", "metadata/builders/anidb", "#anidb-tag"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "AniList Builders", "metadata/builders/anilist", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("AniList Top Rated", "metadata/builders/anilist", "#anilist-top-rated"),
|
|
|
|
|
("AniList Anilist Popular", "metadata/builders/anilist", "#anilist-anilist-popular"),
|
|
|
|
|
("AniList Trending", "metadata/builders/anilist", "#anilist-trending"),
|
|
|
|
|
("AniList Relations", "metadata/builders/anilist", "#anilist-relations"),
|
|
|
|
|
("AniList Studio", "metadata/builders/anilist", "#anilist-studio"),
|
|
|
|
|
("AniList ID", "metadata/builders/anilist", "#anilist-id"),
|
|
|
|
|
("AniList UserList", "metadata/builders/anilist", "#anilist-userlist"),
|
|
|
|
|
("AniList Search", "metadata/builders/anilist", "#anilist-search"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
|
|
|
|
("_menu", "MyAnimeList Builders", "metadata/builders/myanimelist", [
|
2022-10-17 14:00:48 +00:00
|
|
|
("MyAnimeList Search", "metadata/builders/myanimelist", "#myanimelist-search"),
|
|
|
|
|
("MyAnimeList Top All", "metadata/builders/myanimelist", "#myanimelist-top-all"),
|
|
|
|
|
("MyAnimeList Top Airing", "metadata/builders/myanimelist", "#myanimelist-top-airing"),
|
|
|
|
|
("MyAnimeList Top Upcoming", "metadata/builders/myanimelist", "#myanimelist-top-upcoming"),
|
|
|
|
|
("MyAnimeList Top TV Series", "metadata/builders/myanimelist", "#myanimelist-top-tv-series"),
|
|
|
|
|
("MyAnimeList Top Movies", "metadata/builders/myanimelist", "#myanimelist-top-movies"),
|
|
|
|
|
("MyAnimeList Top OVA Series", "metadata/builders/myanimelist", "#myanimelist-top-ova-series"),
|
|
|
|
|
("MyAnimeList Top Specials", "metadata/builders/myanimelist", "#myanimelist-top-specials"),
|
|
|
|
|
("MyAnimeList Most Popular", "metadata/builders/myanimelist", "#myanimelist-most-popular"),
|
|
|
|
|
("MyAnimeList Most Favorited", "metadata/builders/myanimelist", "#myanimelist-most-favorited"),
|
|
|
|
|
("MyAnimeList Suggested", "metadata/builders/myanimelist", "#myanimelist-suggested"),
|
|
|
|
|
("MyAnimeList ID", "metadata/builders/myanimelist", "#myanimelist-id"),
|
|
|
|
|
("MyAnimeList UserList", "metadata/builders/myanimelist", "#myanimelist-userlist"),
|
|
|
|
|
("MyAnimeList Seasonal", "metadata/builders/myanimelist", "#myanimelist-seasonal"),
|
2022-10-17 06:48:08 +00:00
|
|
|
]),
|
2022-03-08 08:06:22 +00:00
|
|
|
]),
|
2022-11-03 19:44:01 +00:00
|
|
|
("_menu", "Settings/Updates", "metadata/update", [
|
|
|
|
|
("Settings/Updates", "metadata/update"),
|
|
|
|
|
("_divider",),
|
|
|
|
|
("Definition Settings", "metadata/details/definition"),
|
|
|
|
|
("Schedule Settings", "metadata/details/schedule"),
|
|
|
|
|
("Radarr/Sonarr Definition Settings", "metadata/details/arr"),
|
|
|
|
|
("Collection/Playlist Metadata Updates", "metadata/details/metadata"),
|
|
|
|
|
("Item Metadata Updates", "metadata/details/item_metadata"),
|
2022-03-08 08:06:22 +00:00
|
|
|
])
|
|
|
|
|
]),
|
|
|
|
|
("❤", "https://github.com/sponsors/meisnate12", True),
|
|
|
|
|
],
|
|
|
|
|
|
|
|
|
|
# Render the next and previous page links in navbar. (Default: true)
|
|
|
|
|
'navbar_sidebarrel': False,
|
|
|
|
|
|
|
|
|
|
# Render the current pages TOC in the navbar. (Default: true)
|
|
|
|
|
'navbar_pagenav': False,
|
|
|
|
|
|
|
|
|
|
# Tab name for the current pages TOC. (Default: "Page")
|
|
|
|
|
'navbar_pagenav_name': "Sections",
|
|
|
|
|
|
|
|
|
|
# Global TOC depth for "site" navbar tab. (Default: 1)
|
|
|
|
|
# Switching to -1 shows all levels.
|
|
|
|
|
'globaltoc_depth': 2,
|
|
|
|
|
|
|
|
|
|
# Include hidden TOCs in Site navbar?
|
|
|
|
|
#
|
|
|
|
|
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
|
|
|
|
|
# non-hidden ``toctree`` directives in the same page, or else the build
|
|
|
|
|
# will break.
|
|
|
|
|
#
|
|
|
|
|
# Values: "true" (default) or "false"
|
|
|
|
|
'globaltoc_includehidden': "true",
|
|
|
|
|
|
|
|
|
|
# HTML navbar class (Default: "navbar") to attach to <div> element.
|
|
|
|
|
# For black navbar, do "navbar navbar-inverse"
|
|
|
|
|
'navbar_class': "navbar navbar-inverse",
|
|
|
|
|
|
|
|
|
|
# Fix navigation bar to top of page?
|
|
|
|
|
# Values: "true" (default) or "false"
|
|
|
|
|
'navbar_fixed_top': "true",
|
|
|
|
|
|
|
|
|
|
# Location of link to source.
|
|
|
|
|
# Options are "nav" (default), "footer" or anything else to exclude.
|
|
|
|
|
'source_link_position': "nav",
|
|
|
|
|
|
|
|
|
|
# Bootswatch (http://bootswatch.com/) theme.
|
|
|
|
|
#
|
|
|
|
|
# Options are nothing (default) or the name of a valid theme
|
|
|
|
|
# such as "cosmo" or "sandstone".
|
|
|
|
|
#
|
|
|
|
|
# The set of valid themes depend on the version of Bootstrap
|
|
|
|
|
# that's used (the next config option).
|
|
|
|
|
#
|
|
|
|
|
# Currently, the supported themes are:
|
|
|
|
|
# - Bootstrap 2: https://bootswatch.com/2
|
|
|
|
|
# - Bootstrap 3: https://bootswatch.com/3
|
|
|
|
|
'bootswatch_theme': "darkly",
|
|
|
|
|
|
|
|
|
|
# Choose Bootstrap version.
|
|
|
|
|
# Values: "3" (default) or "2" (in quotes)
|
|
|
|
|
'bootstrap_version': "3",
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# 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"]
|
|
|
|
|
|
2023-01-24 19:07:42 +00:00
|
|
|
html_css_files = [
|
|
|
|
|
"custom.css",
|
2023-01-24 20:06:33 +00:00
|
|
|
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/all.min.css"
|
2023-01-24 19:07:42 +00:00
|
|
|
]
|
2022-03-08 08:06:22 +00:00
|
|
|
|
|
|
|
|
def setup(app):
|
|
|
|
|
app.add_css_file("custom.css")
|
