Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve config file documentation #1163

Open
ptrcnull opened this issue Aug 2, 2024 · 3 comments
Open

Improve config file documentation #1163

ptrcnull opened this issue Aug 2, 2024 · 3 comments

Comments

@ptrcnull
Copy link
Collaborator

ptrcnull commented Aug 2, 2024

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

@getzze
Copy link
Collaborator

getzze commented Aug 2, 2024

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
Copy link
Collaborator Author

ptrcnull commented Aug 2, 2024

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

@getzze
Copy link
Collaborator

getzze commented Aug 2, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants