doc: fix API link generation

This commit is contained in:
Steven Arcangeli 2022-10-21 20:27:34 -07:00
parent 5deb9c488d
commit 57d7a56b00
2 changed files with 33 additions and 32 deletions

15
.github/generate.py vendored
View file

@ -1,31 +1,24 @@
import json
import os
import os.path
import re
import subprocess
from functools import lru_cache
from typing import List
from nvim_doc_tools import (
Command,
LuaParam,
Vimdoc,
VimdocSection,
commands_from_json,
dedent,
format_md_commands,
format_md_table,
format_vimdoc_commands,
generate_md_toc,
indent,
leftright,
parse_functions,
read_nvim_json,
read_section,
render_md_api,
render_vimdoc_api,
replace_section,
wrap,
)
HERE = os.path.dirname(__file__)
@ -60,6 +53,13 @@ def update_config_options():
)
def add_md_link_path(path: str, lines: List[str]) -> List[str]:
ret = []
for line in lines:
ret.append(re.sub(r"(\(#)", "(" + path + "#", line))
return ret
def update_md_api():
funcs = parse_functions(os.path.join(ROOT, "lua", "aerial", "init.lua"))
lines = ["\n"] + render_md_api(funcs, 2) + ["\n"]
@ -77,6 +77,7 @@ def update_md_api():
r"^<!-- /TOC -->$",
toc,
)
toc = add_md_link_path("doc/api.md", toc)
replace_section(
README,
r"^<!-- API -->$",

View file

@ -559,31 +559,31 @@ hi AerialGuide2 guifg=Blue
<!-- API -->
- [setup(opts)](#setupopts)
- [is_open(opts)](#is_openopts)
- [close()](#close)
- [close_all()](#close_all)
- [close_all_but_current()](#close_all_but_current)
- [open(opts)](#openopts)
- [open_all()](#open_all)
- [focus()](#focus)
- [toggle(opts)](#toggleopts)
- [select(opts)](#selectopts)
- [next(step)](#nextstep)
- [prev(step)](#prevstep)
- [next_up(count)](#next_upcount)
- [prev_up(count)](#prev_upcount)
- [get_location(exact)](#get_locationexact)
- [tree_close_all(bufnr)](#tree_close_allbufnr)
- [tree_open_all(bufnr)](#tree_open_allbufnr)
- [tree_set_collapse_level(bufnr, level)](#tree_set_collapse_levelbufnr-level)
- [tree_open(opts)](#tree_openopts)
- [tree_close(opts)](#tree_closeopts)
- [tree_toggle(opts)](#tree_toggleopts)
- [sync_folds(bufnr)](#sync_foldsbufnr)
- [info()](#info)
- [num_symbols(bufnr)](#num_symbolsbufnr)
- [was_closed(default)](#was_closeddefault)
- [setup(opts)](doc/api.md#setupopts)
- [is_open(opts)](doc/api.md#is_openopts)
- [close()](doc/api.md#close)
- [close_all()](doc/api.md#close_all)
- [close_all_but_current()](doc/api.md#close_all_but_current)
- [open(opts)](doc/api.md#openopts)
- [open_all()](doc/api.md#open_all)
- [focus()](doc/api.md#focus)
- [toggle(opts)](doc/api.md#toggleopts)
- [select(opts)](doc/api.md#selectopts)
- [next(step)](doc/api.md#nextstep)
- [prev(step)](doc/api.md#prevstep)
- [next_up(count)](doc/api.md#next_upcount)
- [prev_up(count)](doc/api.md#prev_upcount)
- [get_location(exact)](doc/api.md#get_locationexact)
- [tree_close_all(bufnr)](doc/api.md#tree_close_allbufnr)
- [tree_open_all(bufnr)](doc/api.md#tree_open_allbufnr)
- [tree_set_collapse_level(bufnr, level)](doc/api.md#tree_set_collapse_levelbufnr-level)
- [tree_open(opts)](doc/api.md#tree_openopts)
- [tree_close(opts)](doc/api.md#tree_closeopts)
- [tree_toggle(opts)](doc/api.md#tree_toggleopts)
- [sync_folds(bufnr)](doc/api.md#sync_foldsbufnr)
- [info()](doc/api.md#info)
- [num_symbols(bufnr)](doc/api.md#num_symbolsbufnr)
- [was_closed(default)](doc/api.md#was_closeddefault)
<!-- /API -->