diff options
author | Steven Arcangeli <stevearc@stevearc.com> | 2024-08-08 10:26:34 -0700 |
---|---|---|
committer | Steven Arcangeli <stevearc@stevearc.com> | 2024-08-08 10:38:36 -0700 |
commit | db4dd28a1e9147307fb78b1066cc8ac57272973b (patch) | |
tree | b4269399d3eeb432fb079bb20adfa3b16287f071 /scripts | |
parent | 38e5f062f241d89ba44f6d67d16b4bf55d3c477e (diff) |
doc: add additional information about debugging
Diffstat (limited to 'scripts')
-rwxr-xr-x | scripts/generate.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/scripts/generate.py b/scripts/generate.py index 30c3b12..f471530 100755 --- a/scripts/generate.py +++ b/scripts/generate.py @@ -26,6 +26,7 @@ README = os.path.join(ROOT, "README.md") DOC = os.path.join(ROOT, "doc") RECIPES = os.path.join(DOC, "recipes.md") ADVANCED = os.path.join(DOC, "advanced_topics.md") +DEBUGGING = os.path.join(DOC, "debugging.md") FORMATTER_OPTIONS = os.path.join(DOC, "formatter_options.md") VIMDOC = os.path.join(DOC, "conform.txt") OPTIONS = os.path.join(ROOT, "scripts", "options_doc.lua") @@ -143,21 +144,22 @@ def update_readme_toc(): ) -def update_recipes_toc(): +def update_tocs(): toc = ["\n"] + generate_md_toc(RECIPES) + ["\n"] replace_section(RECIPES, r"^<!-- TOC -->$", r"^<!-- /TOC -->$", toc) subtoc = add_md_link_path("doc/recipes.md", toc) replace_section(README, r"^<!-- RECIPES -->$", r"^<!-- /RECIPES -->$", subtoc) - -def update_advanced_toc(): toc = ["\n"] + generate_md_toc(ADVANCED) + ["\n"] replace_section(ADVANCED, r"^<!-- TOC -->$", r"^<!-- /TOC -->$", toc) subtoc = add_md_link_path("doc/advanced_topics.md", toc) replace_section(README, r"^<!-- ADVANCED -->$", r"^<!-- /ADVANCED -->$", subtoc) + toc = ["\n"] + generate_md_toc(DEBUGGING) + ["\n"] + replace_section(DEBUGGING, r"^<!-- TOC -->$", r"^<!-- /TOC -->$", toc) + subtoc = add_md_link_path("doc/debugging.md", toc) + replace_section(README, r"^<!-- DEBUGGING -->$", r"^<!-- /DEBUGGING -->$", subtoc) -def update_formatter_options_toc(): toc = ["\n"] + generate_md_toc(FORMATTER_OPTIONS) + ["\n"] replace_section(FORMATTER_OPTIONS, r"^<!-- TOC -->$", r"^<!-- /TOC -->$", toc) subtoc = add_md_link_path("doc/formatter_options.md", toc) @@ -210,8 +212,6 @@ def main() -> None: update_autocmd_md() update_formatter_options_md() update_md_api() - update_recipes_toc() - update_advanced_toc() - update_formatter_options_toc() + update_tocs() update_readme_toc() generate_vimdoc() |