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

Typedoc support #5

Merged
merged 6 commits into from
Oct 19, 2018
Merged

Conversation

ParkourKarthik
Copy link
Contributor

@ParkourKarthik ParkourKarthik commented Oct 15, 2018

This PR enables CI to generate documentation with the help of typedoc and publishes it to gh-pages.

Fixes #3

@ParkourKarthik
Copy link
Contributor Author

ParkourKarthik commented Oct 15, 2018

@DrSensor Sorry, my commit messages are not as per contributor guidelines since I went through the guidelines later only. I hope you could squash it with proper message before merging

@DrSensor DrSensor force-pushed the typedoc-support branch 3 times, most recently from b9537c8 to dc0ff67 Compare October 19, 2018 03:08
@codecov-io
Copy link

codecov-io commented Oct 19, 2018

Codecov Report

Merging #5 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master       #5   +/-   ##
=======================================
  Coverage   81.42%   81.42%           
=======================================
  Files          13       13           
  Lines         140      140           
  Branches       34       38    +4     
=======================================
  Hits          114      114           
  Misses         26       26

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4ead947...c846525. Read the comment docs.

@DrSensor DrSensor changed the title WIP: Typedoc support Typedoc support Oct 19, 2018
@DrSensor DrSensor merged commit e866dbb into DrSensor:master Oct 19, 2018
@DrSensor
Copy link
Owner

Took me a while to figure out why the git submodules cannot be fetched 😅

@ParkourKarthik Thank you for the contribution 👍
Ah yes, does Typedoc can also generate/embed the source code in the documentation?

@DrSensor DrSensor added the hacktoberfest Go get your T-Shirt ⎝⸌﹏⸍⎠ label Oct 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Go get your T-Shirt ⎝⸌﹏⸍⎠
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants