Skip to content

Add phpDocumentor generated PHP SDK Documentation #55

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 16 commits into from
Mar 22, 2023
Merged

Add phpDocumentor generated PHP SDK Documentation #55

merged 16 commits into from
Mar 22, 2023

Conversation

n7studios
Copy link
Contributor

@n7studios n7studios commented Mar 21, 2023 •
edited
Loading

Summary

Adds support for generating API docs in markdown using the command phpDocumentor --directory=src --target=docs --template="vendor/saggre/phpdocumentor-markdown/themes/markdown"

Testing

Existing tests pass.

Checklist

@n7studios n7studios added this to the 1.0.0 milestone Mar 21, 2023
@n7studios n7studios self-assigned this Mar 21, 2023
@n7studios n7studios requested review from a team, noelherrick and jenessawhite and removed request for a team March 21, 2023 16:03
@n7studios n7studios marked this pull request as ready for review March 21, 2023 16:03
@n7studios n7studios mentioned this pull request Mar 21, 2023
Merged
6 tasks
n7studios added 15 commits March 22, 2023 13:15
@n7studios
Merge remote-tracking branch 'origin/1.0-beta' into phpdocumentor
58a37eb
@n7studios
Remove saggre/phpdocumentor-markdown in favor of own phpDocumentor ma…
db3bb31 
…rkdown templates to fix encoding issues
@n7studios
Ignore phpDocumentor ast.dump file for debugging
8d786e7
@n7studios
Parameters table: Description: Replace pipe symbol with comma, instea…
4c696d6 
…d of HTML encoded pipe
@n7studios
Updated instructions for compiling docs
974c439
@n7studios
Fix encoding of single quotation marks in method defaults
8e48007
@n7studios
Experiment with removing macros, header and footer templates
e0ba571
@n7studios
Remove unnecessary spacing in markdown docs
10c9cd3
@n7studios
Further improvements to markdown templates for PHP SDK docs
2236811
@n7studios
Remove unused macros
7a5bba1
@n7studios
Fix encoding on method return types
ff9019f
@n7studios
Add newlines between Parameters and Return Value headings
1fdae1c
@n7studios
Escape pipes in tables for better rendering
37c4624
@n7studios
Escape pipes in tables for argument types
c370af0
@n7studios
Double escape pipe symbols in tables to ensure output renders correctly
0ebf834
@n7studios n7studios merged commit dcf9cd1 into 1.0-beta Mar 22, 2023
@n7studios n7studios deleted the phpdocumentor branch March 23, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@noelherrick noelherrick noelherrick approved these changes

@jenessawhite jenessawhite Awaiting requested review from jenessawhite jenessawhite was automatically assigned from Kit/wordpress

Assignees

@n7studios n7studios

Labels
enhancement
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@n7studios @noelherrick