Codex can't autogenerate API reference. But it can extract docstrings and
render the documentation for functions, methods and classes:
example/app package
foo(first &key (other 100500))This is example function.
Internally it calls EXAMPLE/UTILS:DO-THE-JOB to do the real job.
Note, that the there is no link above because Codex does not support cross referencing yet.
example/app package
do-the-job(first second)The function does the job.
It concatenates first and second arguments calling internal function concat.
On this multiline we'll check how does documentation system processes docstrings.
By the way, pay attention at the second paragraph where I've used Scriba's format to make the word "concatenates" bold.
Also, we can reference some parts of the documentation. Is not a cross-reference though. Read more about writing docs in the Handwritten documentation chapter.
But seems the resulting link is broken because it points to .../handwritten.html/#beginning.
- NOTE
-
There is an issue in
Codexand it does not render function descriptions propertly when running inside the GitHub Action.