Skip to content

Commit

Permalink
Make the default config table searchable in docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
imreddyTeja committed Oct 28, 2024
1 parent 01a1d9e commit 7fd9676
Show file tree
Hide file tree
Showing 4 changed files with 202 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ using DocumenterCitations

disable_logging(Base.CoreLogging.Info) # Hide doctest's `@info` printing
bib = CitationBibliography(joinpath(@__DIR__, "bibliography.bib"))

include(joinpath(@__DIR__, "src", "config_table.jl"))
doctest(ClimaAtmos; plugins = [bib])
disable_logging(Base.CoreLogging.BelowMinLevel) # Re-enable all logging

Expand Down
Loading

0 comments on commit 7fd9676

Please sign in to comment.