Make the default config table searchable in docs #3402
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
|
I think the file should not be checked in with git, since it is dynamically generated |
Sbozzolo
approved these changes
Oct 28, 2024
imreddyTeja
force-pushed
the
tr/make-default-config-table-searchable
branch
from
0401578 to
c1b7376
Compare
The content of the old config.md was moved into config_no_table.md
with the include("config_table.jl") at the bottom removed.
Now, config_table.jl, creates the config.md by reading
config_no_table.md and copying the lines into it. Then,
it generates the pretty table and adds it to the end of the file.
This allows the table to be searchable, but it does not require users
to manually update the docs when the default config yaml is modified.
Fix formatting
Remove generated config.md from git index
imreddyTeja
force-pushed
the
tr/make-default-config-table-searchable
branch
from
c1b7376 to
0251c91
Compare
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.
The content of the old config.md was moved into config_no_table.md with the include("config_table.jl") at the bottom removed.
Now, config_table.jl, creates the config.md by reading config_no_table.md and copying the lines into it. Then, it generates the pretty table and adds it to the end of the file.
This allows the table to be searchable, but it does not require users to manually update the docs when the default config yaml is modified.
Purpose
closes #3301
To-do
Content