Plugin documentation #155
Merged
Plugin documentation #155
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
I've introduced the plugin system with descriptions and examples for the 4 main kinds of plugins (app/dataset routers, dataset providers, and hook spec). I've also tried to explain the common functionality and enough of the underlying system to get folks started building their own.
|
Fixed: Local vs RTD |
|
Great work! One update to the docs, include instead of: I kept chasing my tail for a while wondering why dataset_id wasn't getting anything but the |
|
Whoops, thanks for catching that @jr3cermak! |
It's likely the source of the version mismatch between docutils and sphinx_rtd_theme making bullets disappear. xref: readthedocs/sphinx_rtd_theme#1115
|
Ok, bullets are working on plugin and contributing pages. RTD has a really sticky cache for PR previews.
|
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.
I've introduced the plugin system with descriptions and examples for the 4 main kinds of plugins (app/dataset routers, dataset providers, and hook spec). I've also tried to explain the common functionality and enough of the underlying system to get folks started building their own.
@kwilcox @mpiannucci I'd love your feedback as I'm pretty sure you are both using plugins, and I'd love to hear from anyone else using plugins to about these docs and if there is anything that would help improve them.