[all-commits] [llvm/llvm-project] af34a5: [libc][docs] Introduce docgen (#87682)

[Nick Desaulniers via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: af34a5d382bc7cd93c620efa00dce449de252a0a
      https://github.com/llvm/llvm-project/commit/af34a5d382bc7cd93c620efa00dce449de252a0a
  Author: Nick Desaulniers <nickdesaulniers at users.noreply.github.com>
  Date:   2024-04-05 (Fri, 05 Apr 2024)

  Changed paths:
    A libc/docs/fenv.rst
    M libc/docs/index.rst
    A libc/utils/docgen/ctype.json
    A libc/utils/docgen/docgen.py
    A libc/utils/docgen/fenv.json

  Log Message:
  -----------
  [libc][docs] Introduce docgen (#87682)


This script+config should help us generate more consistent documentation wrt.
what we currently support or not.

As an example usage:

    $ ./libc/utils/docgen/docgen.py fenv.h

Will spit out an RST formatted table that can be copy+pasted into our docs.

The config is not filled out entirely, but doing so and then updating our docs
would be great beginner bugs for new contributors.

Having python+json generate things like docs, or headers (as imagined in
https://github.com/nickdesaulniers/llvm-project/tree/hdr-gen2) is perhaps
easier to work with than tablegen, and doesn't introduce a dependency on a host
tool that needs to be compiled from llvm sources before building the rest of
the libc. This can probably be merged with whatever we end up doing to replace
libc-hdrgen.

Please use

https://llvm.org/docs/CodingStandards.html#python-version-and-source-code-formatting
for keeping this file formatted.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications