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.

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

Generate README / API documentation from docblocks #30

Open
gnarf opened this issue Aug 9, 2019 · 0 comments
Open

Generate README / API documentation from docblocks #30

gnarf opened this issue Aug 9, 2019 · 0 comments

Comments

@gnarf
Copy link
Contributor

gnarf commented Aug 9, 2019 •
edited

Need to go add docblocks for all the methods

There is a package called typedoc and a branch I have up called docs that I've started to work with to get this there...

https://github.com/bocoup/sb-util/blob/docs-tests/docs/classes/_sb_util_.scratchproject.md

typedoc --out docs/ --mode modules --theme markdown --readme none
@gnarf gnarf mentioned this issue Aug 9, 2019
Merged
@gnarf gnarf changed the title Docblocks for methods Generate README / API documentation from docblocks Aug 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gnarf