Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs with phpDocumentor #18

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Docs with phpDocumentor #18

wants to merge 1 commit into from

Conversation

back-2-95
Copy link
Member

@back-2-95 back-2-95 commented Nov 14, 2022

Create html docs with Docker & phpDocumentor.

Docs can be created with:

docker run --rm -v "$(pwd):/data" "phpdoc/phpdoc:3"

TODO:

  • Figure out where so store the html: repo, github pages or nowhere
  • I'd rather not store them in the repo as then they are always packaged with the code (when people install it with Composer)

See https://www.phpdoc.org/

Will resolve #12

@back-2-95 back-2-95 added the documentation Improvements or additions to documentation label Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Full PHP Class Documentation
1 participant