【从零开始玩量化21】backtrader API文档

在线浏览地址:https://zsrl.github.io/backtrader-doc/

问题

最近一直在深入学习backtrader,但backtrader的官网文档其实是一个教程,并没有API Reference,那想深入探究细节就很难。

今天翻了一下backtrader的源码,发现原来API Reference都在源码里,就这好了,对此框架好感度+1

docstring

backtrader的docstring还是很全的,而且重点类和方法写的详细,每个参数的含义都有详细的解释,如果错过了这些,backtrader不可能学会的。

在这里插入图片描述

生成API文档

但如果docstring都散落在源码里,还是不适合查阅的,用pdoc3工具,把源码里的所有docstring都提取出来,发布到网络上在线浏览,将是更方便的事情。

恩,直接发布的Github Page当然是最简单的方法。

结果就有了文章开头的链接。

现在再找方法就不难了,很舒服!

backtrader源码极少更新,所谓文档会很稳定,不需要频繁维护

猜你喜欢

转载自blog.csdn.net/u010214511/article/details/131344399