Add note about autogeneration of plugin docs #395
Merged
Conversation
This file contains 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
github-actions
bot
added
the
documentation
|
Not sure if this is the best place, but it seemed like it. Also happy to reword if this is not clear! |
psobolewskiPhD
approved these changes
Apr 7, 2024
lucyleeow
reviewed
Apr 7, 2024
|
|
||
| Some of the source files for the [Plugin documentation](plugins-index) are | ||
| autogenerated from sources in the [napari/npe2](https://github.com/napari/npe2) | ||
| repository. These files' names start with an underscore `_` and will be |
There was a problem hiding this comment.
Could we add an example, "e.g., _npe2_contributions.md"
There was a problem hiding this comment.
Or even add that these added files all live in docs/plugins/ (I think this is right?)
There was a problem hiding this comment.
I was hesitant to mention filenames and location because these may change and keeping this document up-to-date may be difficult (for example we recently moved a bunch of files under the plugins folder). But I think mentioning they are under "plugins" is reasonable indeed.
|
Let me know if this is better, if it's still confusing I'm happy to reword! |
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.
References and relevant issues
Closes #391
Description
Adds a note about how the plugin docs are generated from npe2 templates through the prep_docs.py script.