Documentation - Githubissues

dysonance / Strategems.jl

Quantitative systematic trading strategy development and backtesting in Julia

Other

162 stars 38 forks source link

Documentation #3

Open dysonance opened 6 years ago

dysonance commented 6 years ago

Need to write more thorough documentation for package functionality.

Examples
- Full walkthrough
- Universe data gathering usage
New infix operators
- Crossover alias (up arrow)
- Crossunder alias (down arrow)

dysonance commented 6 years ago

Might also be a good idea to get a wiki started with some proper walkthroughs and more in-depth explanations.

leferrad commented 4 years ago

I guess it should be enough with a single one made with Documenter.jl. It works pretty well and it is easy to use. Check some examples to see if that could work for this package

http://www.juliaopt.org/JuMP.jl/v0.21.1/
https://gadflyjl.org/stable/
https://leferrad.github.io/OCReract.jl/dev/ (I made this one and it was extremely easy)

Moelf commented 4 years ago

bump, I can try to put up some docks with Documenter; can you make a TODO list or "wish list" for what to include?