✨[#64] add setup configuration documentation generation #97
+127
−1
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
|
Currently creates something like this for Open Klant TokenAuthConfigurationStep
--------------------------
Configuration to set up authentication tokens for Open Klant
.. setup-config-example:: openklant.setup_configuration.steps.TokenAuthConfigurationStep
Renders to this: |
Coperh
commented
Jan 27, 2025
Comment on lines
+16
to
+18
| "step_title": step_path.split(".")[-1], | ||
| "step_description": step.verbose_name, | ||
| "step_path": step_path, |
There was a problem hiding this comment.
I think config steps should have a description/summary variable and verbose_name should be a name that is verbose rather than a summary as it currently seems to be used.
There was a problem hiding this comment.
As in use the current verbose name value as a description and change the verbose_name to a more readable format of the step name: TokenAuthConfigurationStep ==> "Token Authentication Configuration"
|
I think this will be implemented in django-setup-configuration instead right? maykinmedia/django-setup-configuration#57 |
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.
Fixes #64