Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
vendor/
build/cache
.DS_Store

# Documentation
.phpdoc/cache
.phpunit.result.cache
phpdoc.xml
docs/
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,16 @@ Resources are mapped to class types. Methods are available to add objects embed
$canvas->setWidth(500);
$canvas->setHeight(500);
```
See the docs folder for implementation specifications.

### Generating Documentation
Documentation is generated through [`phpdocumentor`](https://docs.phpdoc.org/). To create the documentation run the following:

```sh
composer install
composer docs
```

To modify how the documentation is generated, a custom `phpdoc.xml` file can be provided. See the [`phpdocumentor` configuration docs](https://docs.phpdoc.org/guide/getting-started/configuration.html#configuration) for more details.

## Contributing ##
### Developing with Docker ###
Expand Down
13 changes: 10 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,17 @@
"php": ">=8.1"
},
"require-dev": {
"phpdocumentor/phpdocumentor": "^3.1",
"phpunit/phpunit": "^9.5"
"phpunit/phpunit": "^9.5",
"phpdocumentor/shim": "^3.7"
},
"config": {
"allow-plugins": {
"symfony/flex": true,
"phpdocumentor/shim": true
}
},
"scripts": {
"test": "vendor/bin/phpunit tests"
"test": "vendor/bin/phpunit tests",
"docs": "vendor/bin/phpdoc"
}
}
Loading