Tidy up conf.py file for contributors #632
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jni
approved these changes
Mar 17, 2025
|
@willingc this has some conflicts to resolve. It would be nice to add a bit more documentation for some of the sections (e.g. calendar API key), but that can come later. |
Added a note on the API key. |
melissawm
approved these changes
Mar 17, 2025
|
8000
|
|
Apparently just a transient thing - I'll merge since everything looks good now 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR reorders the docs
conf.pyfile and tidies up comments and section divider comments.New contributors often find configuration files overwhelming or confusing. As napari's
conf.pyfiles has evolved over the years, it's evolved organically. This PR aims to offer new contributors more context on configuration of Sphinx and its extensions.