Commit Graph

7 Commits

Author SHA1 Message Date
David Dougherty c6ceea9a23
DOC-3932: remove frontmatter attributes from module API spec generator (#13377)
This PR removes the Hugo frontmatter from this utility.
2024-07-02 08:25:42 +03:00
Viktor Söderqvist 02acb8fd3a
Module API docs corrections (#10890)
* Fix typo `RedisModule_CreatString` -> `RedisModule_CreateString` (multiple occurrences)
* Make the markdown gen script change all `RM_` to `RedisModule_` even in code examples, etc.
2022-06-21 17:00:24 +03:00
Steve Lorello 9e40b076dd
Module api doc generator, fixing issue with negative lookback terminating at "." (#10832)
There is a little regex that wraps up all the free-floating functions in the doc-block
e.g. malloc() with backticks.
in case of `redis.call()`, it used to wrap just `call()` in backticks.
2022-06-08 15:30:04 +03:00
Viktor Söderqvist ced710fc83
Module API doc script: Mark unreleased API functions (#10674)
* Module API doc script: Mark unreleased API functions

* fix broken quotes in generate-module-api-doc.rb

Co-authored-by: Oran Agra <oran@redislabs.com>
2022-05-03 10:34:18 +03:00
Itamar Haber 6c65345edb
Injects Hugo FrontMatter to module-api.md (#10658) 2022-04-28 08:16:20 +03:00
Oran Agra c42b163332
fix file permissions for scripts in utils folder (#10241)
make sure the scripts are executable
2022-02-05 18:40:09 +02:00
Viktor Söderqvist f4ecc799c8
Add 'Available since' to module API function docs (#10229)
The script which generates the markdown docs from module.c is updated to include
the version in which each module API function was introduced.

The script uses git tags to find this information. If git is not available or if we're not in
a git repo, the 'since' is silently skipped.

The line `**Available since:** (version)` is added after the function prototype

Rename to utils/generate-module-api-doc.rb
2022-02-03 10:25:37 +02:00