feat(project_config): add a new option for reading configuration from a Python file instead of TOML #2498
Conversation
This file contains hidden or 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
… a Python file instead of TOML Configuring StrictDoc with a Python file provides more flexibility when a user has to: - Create custom generators - Remove the existing generators - Customize requirement and document tree validations - Customize project statistics When the Python config feature becomes stable, the TOML config will be deprecated and removed from StrictDoc after some time.
Collaborator
Author
|
As discussed with both of you at different times during the office hours, I am moving to a Python config incrementally. I have not documented the change yet, because I want to give it some testing first. You should get an idea of the new approach by looking at how StrictDoc's own The TOML file will go away because it is much easier to provide more advanced configurations with Python directly. Also, the Python config is type-aware, and an IDE can give more information about the possible options. |
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.
Configuring StrictDoc with a Python file provides more flexibility when a user has to:
When the Python config feature becomes stable, the TOML config will be deprecated and removed from StrictDoc after some time.