Skip to content
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.

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

Add API TOC categories template #7

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

banchan86
Copy link

@banchan86 banchan86 commented Aug 12, 2024

Resolves #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.

banchan86 and others added 6 commits August 8, 2024 14:18
Refactor defineSubOperators function into new BonsaiCommon.js file so it can be  used by ManagedReference and TOC templates
Modify TOC logic and categories in toc.extension.js
- Add Transforms identification logic to defineOperatorType function in BonsaiCommon.js
- Strip OE operator specific code from defineOperatorType
- Add in unique Bonsai combinators, sinks and transform that were missing from defineOperatorType
- Update TOC categories in toc extension.js
@banchan86 banchan86 marked this pull request as ready for review August 13, 2024 00:23
banchan86 and others added 3 commits August 13, 2024 16:23
- as this file ended up only containing one function, it was removed and the function integrated into toc.extension.js
@banchan86 banchan86 mentioned this pull request Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Categorise API nodes in Table of Contents
1 participant