Skip to content
This repository has been archived by the owner on Jan 19, 2021. It is now read-only.

Fix building documentation #63

Merged
merged 1 commit into from
Dec 2, 2018
Merged

Fix building documentation #63

merged 1 commit into from
Dec 2, 2018

Conversation

alextsg
Copy link
Contributor

@alextsg alextsg commented Nov 30, 2018

This PR updates the npm package documentation and fixes the build:docs script. It also improves the process of building documentation, such that we can now specify what to include and exclude from the documentation using JSDoc comments. The resulting index.md should be nearly identical to the previous index.md, but some underscore methods have been removed from the Internal Util Functions section.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.437% when pulling c78acf7 on fix-docs into e6c8107 on master.

Copy link
Member

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's really beautiful, thanks Alex! 👍

@holgerd77 holgerd77 merged commit 8abc418 into master Dec 2, 2018
@holgerd77 holgerd77 deleted the fix-docs branch December 2, 2018 18:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants