Skip to content

Commit

Permalink
Modules API docs: Sections and links (redis#8442)
Browse files Browse the repository at this point in the history
* Modules API docs: Link API function names to their definitions

Occurrences of API functions are linked to their definition.

A function index with links to all functions is added on the bottom
of the page.

Comment blocks in module.c starting with a markdown h2 heading are
used as sections. A table of contents is generated from these
headings.

The functions names are changed from h2 to h3, since they are now
rendered as sub-headings within each section.

Existing sections in module.c are used with some minor changes.
Some documentation text is added or sligtly modified.

The markdown renderer will add IDs which may clash with our
generated IDs. By prefixing section IDs with "section-" we make
them different.

Replace double dashes with a unicode long ndash
  • Loading branch information
zuiderkwast authored Apr 13, 2021
1 parent c6cd1e5 commit d7920ff
Show file tree
Hide file tree
Showing 2 changed files with 259 additions and 67 deletions.
Loading

0 comments on commit d7920ff

Please sign in to comment.