7f26c4e988
This is an ongoing project to revamp the YTDL-Sub docs. Starting point: - Recreate docs folder/file structure - Update root makefile to use new make docs command - Move old docs into new docs folder structure (as a base) - Separate out old docs into individual files to allow better navigation with the new theme
23 lines
1 KiB
ReStructuredText
23 lines
1 KiB
ReStructuredText
.. ytdl-sub documentation master file, created by
|
|
sphinx-quickstart on Fri Dec 15 21:08:10 2023.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to ytdl-sub's documentation!
|
|
====================================
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
guides/index
|
|
config
|
|
deprecation_notices
|
|
presets
|
|
usage
|
|
|
|
.. note:: End goal: https://picard-docs.musicbrainz.org/en/functions/list_by_type.html
|
|
|
|
- step-by-step noob install instructions for each platform
|
|
- pages for each prebuilt preset, showing which variables that can be overridden to do different things (i.e. episode_title)
|
|
- new wiki walkthrough that uses the README config as a starting point, and gradually adds custom changes
|
|
- pages for how to enable custom metadata agents for Kodi/Plex/jellyfin
|
|
- page dedicated to explaining the structure of a config (it's only lightly touched on now, many folks struggle to understand the 'pattern' of presets/plugins/overrides)
|