刚接触,差不多有点通了,记录下大体思路,后面随着学习的深入,再修改。
背景资料
- yii2中文开发文档
- 可以在上面的开发文档里找到 apidoc地址 这个很重要,笔者学习主要过程参照这里
- md格式生成guide文档 这个挺有意思的
- 如果使用composer出现了问题
外加个网站,笔者没继续看下去,或者有用:
Programming With Yii: Generating Documentation
下面是笔者根据github上的文档流程操作,遇到的各种问题:
- 在composer.json中加入 “ yiisoft / yii2-apidoc ”: “ ~2.1.0 ”
笔者按照github上的教程尝试添加 “ yiisoft / yii2-apidoc ”: “ ~2.1.0 ”,运行失败,只能改成上图中的dev-master
了,后来在其它教程中看到可以试一下~2.0.0
。
多尝试一下便可以了。
- composer更新时, Authentication required(packagist.phpcomposer.com) 账号密码到哪里获取?
很长时间没用composer了,然后composer update时出现了上述问题。
最后利用composer镜像加速:
composer config repo.packagist composer https://packagist.laravel-china.org
貌似解决了这个问题,也可能是其它方式解决的。
- vendor/bin/apidoc api source/directory ./output
生成api文档没什么问题,不过是关键一步,所以写上了。
4.vendor/bin/apidoc guide source/docs ./output
guide文档的生成,必要条件是要有md文件。
如图在frontend下面建立guide目录,然后写md文件。
md文件与生成文档的联系可以看:md生成guide文档
md文件如何书写略过了,上的教程很多。
md文件写完后,可以运行命令:vendor/bin/apidoc guide source/docs ./output
5.github中把guide文档和api文档combine到一起,好像也有点问题
但是按照github文档上面的方法,guide和api不能相互转换,可以采用下面的方法:
vendor/bin/apidoc guide source/docs ./output
vendor/bin/apidoc api source/directory ./output
vendor/bin/apidoc guide source/docs ./output
运行完,两种文档可以相互链接。