New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A systematic way to customize TOC in layers is needed #24

Open

strongoier opened this issue Aug 3, 2022 · 0 comments

Contributor

strongoier commented Aug 3, 2022

While the current TOC can be written arbitrarily in a manual way (which is what we want), it is lacking layers, which is a bit non-intuitive:

taichi: The main taichi module
taichi.ad: Taichi Autodiff system
taichi.aot: Taichi AOT system
taichi.linalg: Taichi Linear algebra library
taichi.profiler: Taichi profiler tools
taichi.tools: Miscellaneous tools shipped with Taichi
taichi.types: Taichi types
taichi.types.quant: Taichi quantized types
taichi.ui: Taichi UI components (GUI and GGUI)

We hope the TOC can present layer relationship like the following:

taichi: The main taichi module
  taichi.ad: Taichi Autodiff system
  taichi.aot: Taichi AOT system
  taichi.linalg: Taichi Linear algebra library
  taichi.profiler: Taichi profiler tools
  taichi.tools: Miscellaneous tools shipped with Taichi
  taichi.types: Taichi types
    taichi.types.quant: Taichi quantized types
  taichi.ui: Taichi UI components (GUI and GGUI)

The text was updated successfully, but these errors were encountered:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment