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

Automatically generate documentation and upload it #47

Merged
merged 1 commit into from
Mar 27, 2020

Conversation

phihag
Copy link
Member

@phihag phihag commented Mar 27, 2020

Generate HTML documentation and upload it to https://boxine.github.io/pintf/ .
Currently, the content of the documentation is still sparse.

Only export functions with JSDoc comments, because without --excludeNotDocument, tsdoc will export everything, including stuff like const assert = require('assert');.

Generate HTML documentation and upload it to https://boxine.github.io/pintf/ .
Currently, the content of the documentation is still sparse.

Only export functions with JSDoc comments, because without `--excludeNotDocument`, [tsdoc will export _everything_](TypeStrong/typedoc#639), including stuff like `const assert = require('assert');`.
@marvinhagemeister marvinhagemeister merged commit 042f658 into master Mar 27, 2020
@marvinhagemeister marvinhagemeister deleted the upload-docs branch March 27, 2020 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants