search

Diaoul / subliminal

Subtitles, faster than your thoughts
http://subliminal.readthedocs.org
MIT License
2.4k stars 312 forks source link

Improve config file documentation #1163

Open ptrcnull opened 2 months ago

ptrcnull commented 2 months ago

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

getzze commented 2 months ago

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...

ptrcnull commented 2 months ago

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

getzze commented 2 months ago

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