Skip to content

Commit

Permalink
Add reference to API doc on github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mstilkerich committed Mar 3, 2021
1 parent b080f49 commit 343549b
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Expand Up @@ -98,10 +98,8 @@ also uses this library for the interaction with the CardDAV server.

### API documentation

An overview of the API is availabe [here](doc/README.md).
An overview of the API is available [here](doc/README.md).

Documentation for the API can be generated from the source code using [phpDocumentor](https://www.phpdoc.org/).
The API documentation for the latest released version can be found [here](https://mstilkerich.github.io/carddavclient/).

```sh
phpdoc -d src/ -t doc/api/ --title="CardDAV Client Library"
```
Documentation for the API can be generated from the source code using [phpDocumentor](https://www.phpdoc.org/) by running `make doc`.

0 comments on commit 343549b

Please sign in to comment.