itco/ldapi

连接到Astatine LDAP的本地API

v2.1.0 2021-11-11 17:15 UTC

README

CodeFactor codecov Documentation Status

此仓库包含LDAPI的源代码。
使用composer获取此库的实例。如果您打算进一步开发,请直接克隆此仓库。

有关更多详细信息和说明,请参阅相应的BitBucket wiki:https://bitbucket.org/itco/ldapi/wiki/Home

文档

文档由ReadTheDocs自动构建并托管:https://ldapi.readthedocs.io/

此文档通过Doxygen和Sphinx(Python包)以及Breathe扩展构建。构建方法如下:

cd docs
make html

运行pip install -r docs/requirements.txt以获取所需的包。
构建输出可在docs/_build/html中找到。

PHPDoc

使用phpDocumentor构建文档的更简单方法是。生成的PHPDoc文档可在此处找到:https://itco.bitbucket.io/ldapi/index.html(注意:此文档不是自动构建的,可能已过时)。

使用以下命令生成文档:

phpdoc -d ./src -t ./phpdoc_build

使用-d设置输入,使用-t设置输出。

使用Composer获取

  • 运行composer require itco/ldapi。该软件包被添加到应下载的软件包列表中。
  • 运行composer update以实际下载它们。
  • 使用您的配置创建config/ldapi.phpvendor/itco/ldapi/cofnig/ldapi.default.php可作为参考。

有关部署、使用和开发的更多信息,请参阅wiki。

开发

需要itco/ldapi:dev-development以获取不稳定的最新版本。

变更日志

查看CHANGELOG.md以获取概述。