Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: List all conf options in one place #276

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

Closed
larsoner opened this issue Jul 30, 2017 · 3 comments
Closed

DOC: List all conf options in one place #276

larsoner opened this issue Jul 30, 2017 · 3 comments

Comments

@larsoner
Copy link
Contributor

I'm not 100% sure e.g. #275 is valid (maybe something to do it exists already in SG?) because I couldn't find one place where all SG conf options were listed. I propose adding a single place that lists all options, and linking to the relevant advanced- or basic-doc sections to describe each entry as necessary.

I can take a stab at this if people agree it would help.

@larsoner
Copy link
Contributor Author

... for example, I couldn't find anywhere in the docs that mentioned how to set the thumbnail size. There is probably some way to do it but I don't know after some looking at docs and code searching. After looking at the code I finally figured out there probably is no way to set it. Having a list in one place would have made it obvious.

@choldgraf
Copy link
Contributor

This I think is a good idea - I found discovering the various functionality in sphinx-gallery to be a bit difficult as well. I think there should be one place that gives a docstring-style explanation of each possible configuration option.

@Titan-C
Copy link
Member

Titan-C commented Jul 31, 2017

I can take a stab at this if people agree it would help.

I agree our docs are not the most discoverable. Thus at least explaining all our defaults in one place and having the link to the docs on how to modify them is extremely helpful.

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

3 participants