Update documentation for config #217
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
Add info on how to add parameters to the config
|
@nichollsh Could you have a look at this PR? I mostly copy-pasted from the default config, but I'm sure you have much more to say. Feel free to push to this branch if you have any changes you want to make. |
|
@stefsmeets I am happy with this now! Thanks for the quick work in getting this setup. I updated the docstrings to provide some more information and improve the formatting. I also added some reference data on a new page, since it's useful for knowing what values to set in the |
|
Nice work @nichollsh ! Looks good to me, could you approve the PR so that it can be merged? |
nichollsh
approved these changes
Oct 22, 2024
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.
This PR sets up mkdocstrings for config documentation. I also added docstrings for all the parameters. Its a single page, so it's nicely ctrl-F-able 😅
See https://fwl-proteus.readthedocs.io/en/config-docs/config/ for how it looks.
I kept the old config page around too, because I still want to source it for validation in #200. I think it can be removed afterwards.
Closes #201