Comments (6)
I think the last time I had a look at it, I didn't find any nice tool for TypeScript API docs generation. I'll try and look into it some more to see if I can find a good option.
Also, thanks a bunch for your input - really appreciated!
from devalpha-node.
Thanks for the kind words.
I understand it can take more effort to select and integrate and learn a tool than you get out of it. In this situation I'll manually make up Markdown tables for my own reference. If they're useful to anybody else, so much the better. I'll probably badger you to fill in some essential holes. :)
(Probably a day or two before I'll have time to work up the tables).
from devalpha-node.
I made a go, but Markdown isn't up to the task. I'll think about writing it in JCreole and posting to my own site. JCreole is a wikitext engine I wrote some years back and it supports cell spanning, nesting code blocks within cells, etc. Or maybe I'll bit the bullet, learn an API-generating tool and post the output on my own site. Enough time spent on documentation today though.
from devalpha-node.
I tried jsdoc, but it's not up to the task. It doesn't recurse enough to be useful. For example, it sees that the strategy param to createTrader
is a Strategy
, but it can't build docs for createStrategy.js
.
Guess I'll probably document this with JCreole, but now I'm working on strategies that use ticker/Time&Sales events instead of bars as input, so using my own driver. (Since the DevAlpha dashboard only works with OHLC/candlestick-like timeslice inputs).
from devalpha-node.
I'm currently looking into if it is possible to leverage Documentalist. Will keep you posted on the progress!
from devalpha-node.
Documentalist proved to be even less mature than Typedoc, so I gave Typedoc one more chance. An API reference for devalpha-node can now be found at https://devalpha-io.github.io/website/api/. Enjoy!
from devalpha-node.
Related Issues (16)
- Realtime trading? HOT 1
- backtesting cash synchronization problem
- broken links on Github HOT 1
- Tick data HOT 3
- Roadmap HOT 1
- Provide a realtime example
- error TS2304: Cannot find name 'Element'. HOT 1
- Allow charting of custom variables
- Quickstart problems HOT 1
- README.md Quickstart problem HOT 1
- Another doc mistake on devalpha.io HOT 1
- Missing Custom Broker docs
- generality of dashboard HOT 3
- Cannot connect to backtester HOT 2
- favicon
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from devalpha-node.