neovim/.github
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
..
actions ci: bump cache action to version 4 2024-01-20 12:49:43 +01:00
ISSUE_TEMPLATE docs: update FAQ URLs #27236 2024-01-28 14:53:05 -08:00
scripts ci(release): run universal_macos build on M1 (#27505) 2024-02-17 13:35:47 +01:00
workflows feat(docs): replace lua2dox.lua 2024-02-27 14:41:17 +00:00
dependabot.yml ci: use "ci" as the commit type for dependabot updates 2023-03-24 05:39:18 +01:00
FUNDING.yml funding: Bountysource Salt -> GitHub Sponsors & Open Collective [ci skip] (#12959) 2020-09-21 20:47:02 +02:00
SECURITY.md docs: add security policy (#17338) 2022-12-22 13:20:19 +01:00