Google Git Google Git
Sign in
fuchsia/fuchsia/main/./tools/docsgen
tree: 61e988d31b1fa9bd79f3dd1e0577267f6bd4ddc3 [search]
  1. tests/
  2. BUILD.bazel
  3. BUILD.gn
  4. clidoc_run.py
  5. clidoc_test.py
  6. docsgen_transforms.py
  7. gen_helpdocs.py
  8. gen_syscalls_toc.py
  9. OWNERS
  10. README.md
  11. reference_doc_checker_test.py
tools/docsgen/README.md

Docsgen

The present tool generates reference documentation without the usage of recipes. Currently the following generation is supported.

  • bazel-docgen
  • Clidoc
  • CMLdoc
  • Dart
  • Driversdoc
  • FIDL
  • Helpdoc
  • Syscalls

Usage

Docsgen can be built using the command fx build tools/docsgen

For example, you can set it to a minimal configuration:

fx set minimal.x64 --with //tools/docsgen

Then, build docsgen:

fx build tools/docsgen

You can then see the built documentation in the out/default/obj/tools/docsgen directory of your Fuchsia checkout.