subliminal icon indicating copy to clipboard operation
subliminal copied to clipboard

Improve config file documentation

Open ptrcnull opened this issue 1 year ago • 3 comments

as of now, there's next to no documentation on how the config file structure actually should look

ptrcnull avatar Aug 02 '24 14:08 ptrcnull

Correct, there is just an example.

It would be important to document because most of the parameters for the providers and refiners are only accessible through the config file...

getzze avatar Aug 02 '24 21:08 getzze

oh, i couldn't even find the example on https://subliminal.readthedocs.io/en/latest/index.html

ptrcnull avatar Aug 02 '24 21:08 ptrcnull

ReadTheDocs does not update with new release or commit. I don't know why. You can build the docs locally and see the example file. Introduced in #1139, it's shown from docs/user/usage.rst

getzze avatar Aug 02 '24 23:08 getzze