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 template #9

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
138ce43
Initial commit of template files
banchan86 Aug 8, 2024
3053524
Delete files not required for API template
banchan86 Aug 14, 2024
3e629e3
Add refactored Bonsai and Mref js extensions
banchan86 Aug 14, 2024
2bd0687
Add back required mref.overwrite.js
banchan86 Aug 14, 2024
0d08ec1
Remove OE specific code from define inputs and outputs
banchan86 Aug 14, 2024
45e03d4
Add missing source link for enums
banchan86 Aug 15, 2024
bebd2e0
Simplify enum processing and strip OE specific code
banchan86 Aug 15, 2024
9a1f75d
Strip OE specific suboperator functions
banchan86 Aug 15, 2024
428370d
Strip inherited members in properties table
banchan86 Aug 15, 2024
56accf5
Revert "Strip inherited members in properties table"
banchan86 Aug 15, 2024
18a26ab
Add doc comments for inherited members property table
banchan86 Aug 15, 2024
b6b75e6
Delete unnecessary conceptual markdown template
banchan86 Aug 15, 2024
6c37c73
Add images and modified code for input/output diagram
banchan86 Aug 15, 2024
c5e70d7
Strip OE specific code from class partial template
banchan86 Aug 15, 2024
1c8e075
Remove operator tables from diagram partial template
banchan86 Aug 15, 2024
a575f78
Replace OE with Bonsai in variable names
banchan86 Aug 15, 2024
10337fd
Remove dataframe ref in defineinputoutput
banchan86 Aug 16, 2024
031e25d
Minor code cleanup, finished conversion of template
banchan86 Aug 16, 2024
1094df6
Add relationships to classes/enums
banchan86 Aug 16, 2024
7904709
Add constructors to classes
banchan86 Aug 16, 2024
6e2ff2a
Refactor defineOperatorType function
banchan86 Aug 19, 2024
2078a6f
Refactor some functions
banchan86 Aug 20, 2024
ebcef62
Refactor functions, add styles.css for template table formatting
banchan86 Aug 22, 2024
a861834
Surface links to Bonsai docs for observables and operators
banchan86 Aug 22, 2024
3000e21
Remove constructors from API pages
banchan86 Aug 22, 2024
74dbb7a
Update readme with installation instructions
banchan86 Aug 22, 2024
5ee6e60
Update README with instructions for operator workflow containers
banchan86 Aug 22, 2024
968ca4a
Update README after decoupling API TOC from API template
banchan86 Aug 23, 2024
0f97d2e
Refactor IO diagram, reduce size
banchan86 Sep 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Strip OE specific code from class partial template
  • Loading branch information
banchan86 committed Aug 15, 2024
commit c5e70d743d7f0a0be6a2f79a929b5a2d8397d8af
50 changes: 1 addition & 49 deletions template/api/partials/class.tmpl.partial
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

<div>
<h1 id="{{id}}" data-uid="{{uid}}" class="text-break" style="display: inline-block;">
{{name.0.value}}
{{name.0.value}}hi
{{#sourceurl}}<a class="header-action link-secondary" title="View source" href="{{sourceurl}}"><i class="bi bi-code-slash"></i></a>{{/sourceurl}}
</h1>
{{#oe.operatorType}}
@@ -21,56 +21,10 @@
{{#oe.operatorType}}

<h2>Inputs & Outputs</h2>

{{>partials/diagram}}

{{/oe.operatorType}}

{{#oe.hasSubOperators}}

<h2>Properties</h2>

<div>{{name.0.value}} is a aggregate operator. It comprises of the following sub-operators: </div>
<br>

{{#oe.subOperators}}

<h3>{{{object}}}</h3>

{{#subOperator}}
<div>{{{object}}} is a {{{type}}} operator encapsulated by the {{name.0.value}} operator.</div>
{{/subOperator}}

{{#hasSubProperties}}

<table>

<tr>
<th style = "white-space: nowrap;">Property</th>
<th style = "white-space: nowrap;">Type</th>
<th>Description</th>
</tr>

{{#subProperties}}
{{>partials/propertyTables}}
{{/subProperties}}

</table>

{{/hasSubProperties}}

{{^hasSubProperties}}

<div>This subclass has no public properties.</div>

{{/hasSubProperties}}

{{/oe.subOperators}}

{{/oe.hasSubOperators}}

{{^oe.hasSubOperators}}

{{#oe.hasProperties}}

<h2>Properties</h2>
@@ -91,6 +45,4 @@

{{/oe.hasProperties}}

{{/oe.hasSubOperators}}

{{/isClass}}