mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-03-14 12:57:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3d96e3f9f25389e979bb7f2417ec2135f79fbfbb
neovim/runtime/doc
History
Lewis Russell 9beb40a4db feat(docs): replace lua2dox.lua 
Problem:

The documentation flow (`gen_vimdoc.py`) has several issues:
- it's not very versatile
- depends on doxygen
- doesn't work well with Lua code as it requires an awkward filter script to convert it into pseudo-C.
- The intermediate XML files and filters makes it too much like a rube goldberg machine.

Solution:

Re-implement the flow using Lua, LPEG and treesitter.

- `gen_vimdoc.py` is now replaced with `gen_vimdoc.lua` and replicates a portion of the logic.
- `lua2dox.lua` is gone!
- No more XML files.
- Doxygen is now longer used and instead we now use:
  - LPEG for comment parsing (see `scripts/luacats_grammar.lua` and `scripts/cdoc_grammar.lua`).
  - LPEG for C parsing (see `scripts/cdoc_parser.lua`)
  - Lua patterns for Lua parsing (see `scripts/luacats_parser.lua`).
  - Treesitter for Markdown parsing (see `scripts/text_utils.lua`).
- The generated `runtime/doc/*.mpack` files have been removed.
   - `scripts/gen_eval_files.lua` now instead uses `scripts/cdoc_parser.lua` directly.
- Text wrapping is implemented in `scripts/text_utils.lua` and appears to produce more consistent results (the main contributer to the diff of this change).
2024-02-27 14:41:17 +00:00
..
api.txt
feat(docs): replace lua2dox.lua
2024-02-27 14:41:17 +00:00
arabic.txt
docs: remove trailing spaces #24455
2023-07-25 05:07:13 -07:00
autocmd.txt
vim-patch:e13b665a6e2a (#27163)
2024-01-24 06:07:42 +08:00
backers.txt
docs: convert BACKERS.md to backers.txt
2023-12-28 22:41:01 +01:00
builtin.txt
vim-patch:a35235e824bb (#27598)
2024-02-24 17:55:32 +08:00
change.txt
vim-patch:955652f6df9c (#26667)
2023-12-20 07:02:48 +08:00
channel.txt
docs: small fixes (#25585)
2023-10-29 16:02:32 +08:00
cmdline.txt
vim-patch:61e984e212ed (#26484)
2023-12-09 15:35:45 +08:00
debug.txt
vim-patch:8.1.1306: Borland support is outdated and doesn't work
2019-05-09 20:27:11 -04:00
deprecated.txt
refactor(lsp): deprecate vim.lsp.util.lookup_section
2024-01-16 20:14:17 +00:00
dev_style.txt
docs: various fixes (#26929)
2024-01-17 14:01:39 +08:00
dev_theme.txt
feat(highlight): tweak default color scheme
2023-12-16 14:43:03 +01:00
dev_tools.txt
docs: fix links
2023-12-13 20:31:16 +01:00
dev_vimpatch.txt
vim-patch:9.1.0137: <Del> in cmdline mode doesn't delete composing chars (#27636)
2024-02-27 06:09:06 +08:00
develop.txt
docs: small fixes
2024-01-02 22:00:06 +01:00
diagnostic.txt
feat(docs): replace lua2dox.lua
2024-02-27 14:41:17 +00:00
diff.txt
vim-patch:partial:6f4754b9f725
2023-04-17 15:46:24 +08:00
digraph.txt
vim-patch:9.0.2056: no digraph for quadruple prime
2023-10-20 13:03:36 +02:00
editing.txt
vim-patch:93197fde0f1d
2024-01-15 11:40:44 +01:00
editorconfig.txt
docs: small fixes (#26243)
2023-12-06 08:04:21 +08:00
eval.txt
vim-patch:b8170143c8f8 (#27387)
2024-02-08 19:07:31 +08:00
faq.txt
docs: fix links
2023-12-13 20:31:16 +01:00
filetype.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
fold.txt
feat(folds): support virtual text format for 'foldtext' (#25209)
2023-09-17 20:29:18 +08:00
ft_ada.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
ft_ps1.txt
vim-patch:4d8f476176ea (#15612)
2021-09-10 08:48:27 +02:00
ft_raku.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
ft_rust.txt
docs: small fixes (#25585)
2023-10-29 16:02:32 +08:00
ft_sql.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
gui.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
hebrew.txt
feat(edit)!: remove old c implementation of hebrew keymap
2023-02-28 15:14:03 +01:00
help.txt
docs: move vim-patch wiki page to runtime documentation
2023-12-13 18:31:05 +01:00
helphelp.txt
docs: fix misparsed headings (#24162)
2023-06-26 11:16:55 +02:00
if_perl.txt
test: spellcheck :help (vimdoc) files #24109
2023-06-22 03:44:51 -07:00
if_pyth.txt
docs: remove trailing spaces #24455
2023-07-25 05:07:13 -07:00
if_ruby.txt
vim-patch:8.2.0578: heredoc for interfaces does not support "trim"
2023-04-29 09:20:52 +08:00
indent.txt
vim-patch:d96f25bd69c1
2023-12-30 10:53:31 +01:00
index.txt
vim-patch:9c5b90db035b
2024-01-24 11:05:25 +01:00
insert.txt
vim-patch:9.1.0015: i_CTRL-R- no longer works in replace mode
2024-01-13 08:29:47 +08:00
intro.txt
docs: add wiki FAQ to the runtime documentation (#26539)
2023-12-13 17:31:39 +01:00
job_control.txt
docs: small fixes
2023-05-13 21:33:22 +02:00
lsp.txt
feat(docs): replace lua2dox.lua
2024-02-27 14:41:17 +00:00
lua-guide.txt
docs: small fixes (#26243)
2023-12-06 08:04:21 +08:00
lua.txt
feat(docs): replace lua2dox.lua
2024-02-27 14:41:17 +00:00
luaref.txt
docs: small fixes
2024-01-02 22:00:06 +01:00
luvref.txt
build(deps): bump luv to v1.48.0-0
2024-02-22 10:07:04 +01:00
map.txt
vim-patch:9.1.0058: Cannot map Super Keys in GTK UI (#27204)
2024-01-26 11:04:54 +08:00
mbyte.txt
refactor(grid): make screen rendering more multibyte than ever before
2023-11-17 12:58:57 +01:00
message.txt
vim-patch:9.0.2183: Maximum callback depth is not configurable (#26703)
2023-12-22 10:33:34 +08:00
mlang.txt
docs: fix/remove invalid URLs #20647
2022-10-14 08:01:13 -07:00
motion.txt
docs: various #25289
2024-01-18 00:14:48 -08:00
news-0.9.txt
docs: do not hardcode LSP version in URL #25648
2023-10-16 08:13:37 -07:00
news.txt
feat(treesitter): add folding for InspectTree (#27518)
2024-02-22 14:58:59 -06:00
nvim_terminal_emulator.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
nvim.txt
docs #20986
2022-12-11 18:41:26 -08:00
options.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
pattern.txt
vim-patch:d3e277f279ed (#25734)
2023-10-21 18:04:08 +08:00
pi_gzip.txt
vim-patch:30c762d99ac8
2023-11-14 23:29:09 +01:00
pi_health.txt
fix(health): replace healthFoo with DiagnosticFoo (#23475)
2023-05-05 18:15:44 +02:00
pi_msgpack.txt
vim-patch:9.0.1335: no test for bad use of spaces in help files (#24483)
2023-07-25 20:58:09 +08:00
pi_netrw.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
pi_paren.txt
vim-patch:91f84f6e11cd
2018-10-29 09:55:07 +01:00
pi_spec.txt
docs: fix treesitter parsing errors
2023-01-01 15:05:13 +01:00
pi_tar.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
pi_tutor.txt
runtime: Include vim-tutor-mode
2015-08-15 15:25:30 -03:00
pi_zip.txt
vim-patch:da4e433dc3be (#25912)
2023-11-06 19:03:08 +08:00
provider.txt
fix(osc52): enable OSC 52 by default in tmux sessions (#26072)
2023-11-16 13:56:05 -06:00
quickfix.txt
vim-patch:partial:d086b8f646a6 (#27623)
2024-02-25 16:38:34 +08:00
quickref.txt
docs: small fixes (#26243)
2023-12-06 08:04:21 +08:00
recover.txt
docs: various #25289
2024-01-18 00:14:48 -08:00
remote_plugin.txt
docs: small fixes
2023-10-10 19:20:32 +02:00
remote.txt
vim-patch:partial:938ae280c79b (#22356)
2023-02-21 23:50:29 +08:00
repeat.txt
docs(lua): update ":{range}lua" docs + error message #27231
2024-01-27 10:40:30 -08:00
rileft.txt
docs: fix treesitter parsing errors
2023-01-01 15:05:13 +01:00
russian.txt
docs #24061
2023-06-19 08:40:33 -07:00
scroll.txt
vim-patch:5277cfaf8afe (#25397)
2023-09-28 05:22:09 +08:00
sign.txt
docs: small fixes (#26154)
2023-11-27 17:43:13 +08:00
spell.txt
vim-patch:10e8ff9b2607 (#23977)
2023-06-11 12:40:22 +01:00
starting.txt
docs(starting.txt): correct step number (#26185)
2023-11-24 07:19:06 +08:00
support.txt
docs: fix typos
2023-04-04 19:07:33 +02:00
syntax.txt
vim-patch:f7f33e3719c8
2024-02-06 11:42:15 +01:00
tabpage.txt
docs: fix typos (#20150)
2022-09-26 17:43:23 +08:00
tagsrch.txt
docs: remove trailing spaces #24455
2023-07-25 05:07:13 -07:00
term.txt
docs(term): use tic -x for better compatibility with old ncurses (#25421)
2023-09-29 10:57:02 -05:00
testing.txt
fix(lua): improve annotations for stricter luals diagnostics (#24609)
2023-08-09 11:06:13 +02:00
tips.txt
vim-patch:6a500661a9cb
2023-08-10 17:28:02 +08:00
treesitter.txt
feat(docs): replace lua2dox.lua
2024-02-27 14:41:17 +00:00
uganda.txt
vim-patch:e978b4534a5e (#24697)
2023-08-13 13:25:10 +01:00
ui.txt
feat(ui): add support for OSC 8 hyperlinks (#27109)
2024-01-24 16:36:25 -06:00
undo.txt
vim-patch:9.0.1683: Updated runtime files (#24638)
2023-08-10 17:45:36 +08:00
userfunc.txt
vim-patch:9.0.2059: outstanding exceptions may be skipped (#25736)
2023-10-21 18:46:52 +08:00
usr_01.txt
vim-patch:b7398fe41c9e (#23627)
2023-05-15 09:38:32 +02:00
usr_02.txt
refactor(options)!: graduate some more shortmess flags
2023-09-25 18:23:15 +02:00
usr_03.txt
vim-patch:71badf9547e8 (#23285)
2023-04-23 15:22:55 +02:00
usr_04.txt
docs: update explanation of Y to reflect new defaults
2022-02-24 18:13:44 +08:00
usr_05.txt
vim-patch:81b8bf5b4a33
2023-08-10 17:28:04 +08:00
usr_06.txt
feat!: remove hardcopy
2023-01-03 10:07:43 +00:00
usr_07.txt
docs: update explanation of Y to reflect new defaults
2022-02-24 18:13:44 +08:00
usr_08.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_09.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_10.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_11.txt
docs #24061
2023-06-19 08:40:33 -07:00
usr_12.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_20.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_21.txt
docs: remove trailing spaces #24455
2023-07-25 05:07:13 -07:00
usr_22.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_23.txt
vim-patch:4072ba571bab
2021-05-01 22:29:03 -04:00
usr_24.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_25.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_26.txt
vim-patch:d473c8c10126
2018-10-29 10:01:44 +01:00
usr_27.txt
vim-patch:2547aa930b59
2021-04-29 09:27:19 -04:00
usr_28.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_29.txt
fix(docs): vimdoc syntax errors
2023-06-26 11:29:12 +02:00
usr_30.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
usr_31.txt
vim-patch:e7b1ea0276cc
2021-04-29 20:42:16 -04:00
usr_32.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_40.txt
fix(docs): vimdoc syntax errors
2023-06-26 11:29:12 +02:00
usr_41.txt
vim-patch:9.1.0120: hard to get visual region using Vim script
2024-02-23 06:39:03 +08:00
usr_42.txt
docs(manual): fix treesitter parsing errors
2023-01-01 15:05:21 +01:00
usr_43.txt
docs: remove trailing spaces #24455
2023-07-25 05:07:13 -07:00
usr_44.txt
vim-patch:8024f9363683
2021-04-27 09:21:34 -04:00
usr_45.txt
docs #24061
2023-06-19 08:40:33 -07:00
usr_toc.txt
feat!: remove hardcopy
2023-01-03 10:07:43 +00:00
various.txt
Use Lua autocommand and make TermClose autocommand global
2023-08-10 09:53:56 -05:00
vi_diff.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
vim_diff.txt
docs: improve 'tabline' click label docs (#27529)
2024-02-19 11:22:00 +08:00
visual.txt
feat(defaults): map Q and @x to repeat in Visual mode (#26495)
2023-12-27 07:26:18 +08:00
vvars.txt
feat(terminal): trigger TermRequest autocommand events (#22159)
2024-01-09 08:27:56 -06:00
windows.txt
feat(health): make :checkhealth support more split modifiers (#26731)
2023-12-25 10:21:13 +08:00