bonsai-rx / docfx-tools

The standard docfx template for package documentation
MIT License
0 stars 2 forks source link

Add API TOC categories template #7

Open banchan86 opened 3 months ago

banchan86 commented 3 months ago

Resolves https://github.com/bonsai-rx/docfx-tools/issues/6 by sorting API nodes in the TOC into standard Bonsai Workflow categories.

See README for usage instructions.

Note: When I tested it in my local preview just having bonsai/template wasn't enough (unintuitive and not sure it is supposed to work that way) but it may be for the best since bonsai/template currently contains the workflow container css/js template and some packages might want to import only that and not the API TOC template.

An online preview of this PR can be seen at: https://banchan86.github.io/machinelearning_docs/api/Bonsai.ML.LinearDynamicalSystems.html

Edit: As I'm looking at it I also realised the namespace page should reflect the TOC grouping, will work on that too.