Skip to content

Commit

Permalink
add api-references
Browse files Browse the repository at this point in the history
  • Loading branch information
Evgeny Metelkin committed Mar 27, 2020
1 parent 1d4739c commit 1e2df5f
Show file tree
Hide file tree
Showing 7 changed files with 811 additions and 43 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ node_modules
*.log

.nyc_output

/jsdoc
20 changes: 20 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"plugins": ["plugins/markdown"],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc", "closure"]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": true,
"default": {
"outputSourceFiles": false
}
}
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The next steps should be taken using console (shell): **cmd**, **PowerShell**, *

## Usage of command line interface

*More options and examples see on [CLI references](./docs/cli-references)*
*More options and examples see on [CLI references](./cli-references)*

The following example creates one Heta module and compiles the model it to SBML format. For example you want to create platform in directory "platform/directory/path/"

Expand Down
6 changes: 6 additions & 0 deletions api-references.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# API references

- Builder
- Container
- Namespace
- _Component
File renamed without changes.
Loading

0 comments on commit 1e2df5f

Please sign in to comment.