stainlessai / micronaut-jupyter

A Micronaut configuration that integrates your app with an existing Jupyter installation.
https://stainlessai.github.io/micronaut-jupyter
Apache License 2.0
9 stars 5 forks source link

MJ-40 ⁃ Document configuration properties #40

Open stainlessbot opened 4 years ago

stainlessbot commented 4 years ago

Add a configuration reference to the documentation that documents all the properties for this configuration. I'm not 100% sure how this is accomplished in micronaut-docs, but I believe the plugin may just be searching for any instances of @ConfigurationProperties in the src and then converting that to docs.

Using @ConfigurationProperties is likely preferable to just injecting single config values like I am doing, and I may want to switch to using that (especially if my above assumption is true). However, I don't think I'll be able to use it everywhere as I frequently using config values in other annotations.

┆Reporter: Joshua Carter ┆Issue Type: Story ┆Priority: High ┆Status: Backlog ┆Issue Number: MJ-40 ┆Epic: Documentation