【文件属性】:
文件名称:dev-manual:此仓库包含INK扩展的文档
文件大小:9.45MB
文件格式:ZIP
更新时间:2021-05-13 09:16:01
HTML
这是用于开发人员的INK文档生成器。
笔记:
documentation本文档尚在开发中。 请不要使用/遵循说明,因为我们仍在进行实施。
用法
假设您已经安装了Python 3。 您需要安装sphinx和sphinx_rtd_theme才能生成文档
使用pip3,您可以使用以下命令进行安装。
pip3 install sphinx
pip3 install sphinx_rtd_theme
然后,可以通过运行以下命令生成文档:
make html
要清除先前生成的文档,请使用:
make clean
发布文件
Nodejs并未在生成文档的任何地方使用,但需要为某些内部管理任务而构建。 换句话说,您无需执行npm i但仍需要在计算机上安装Nodejs才能发布。
推向master之前:运行npm run build命令。 就是这样,如果没有遇到错误,docs文件夹将准备好推送。