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

Replace documentation with jsdoc with mocha flavor #3328

Merged
merged 6 commits into from
Apr 21, 2018
Merged

Replace documentation with jsdoc with mocha flavor #3328

merged 6 commits into from
Apr 21, 2018

Conversation

Munter
Copy link
Contributor

@Munter Munter commented Apr 14, 2018

Switched api docs generation from documentation to jsdoc with the new mocha-docdash theme applied.

Also removed a bunch of error inducing comments in a lot o files.

The jsdoc output it not entirely useful yet, but more than the documentation output was.

There's still some work needed to get the jsdoc comments to actually produce really good output

Copy link
Contributor

@outsideris outsideris left a comment

Choose a reason for hiding this comment

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

Awesome!!

Copy link
Contributor

@boneskull boneskull left a comment

Choose a reason for hiding this comment

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

mad and sick

please update with @mocha/docdash and merge!

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Apr 19, 2018
@boneskull
Copy link
Contributor

boneskull commented Apr 21, 2018

I rebased all this crap onto master, updated the template package to @mocha/docdash and added docs/API.md. see result (or just append /api/ to the netlify preview URL)

oh, and added @mocha/docdash to Travis CI

@coveralls
Copy link

Coverage Status

Coverage remained the same at 90.009% when pulling 4cdd671 on jsdoc into 3a65a64 on master.

@Munter Munter merged commit efff26f into master Apr 21, 2018
@Munter Munter deleted the jsdoc branch April 21, 2018 14:24
@boneskull boneskull added this to the next milestone May 17, 2018
wopian referenced this pull request in wopian/agc-assembly May 20, 2018
This Pull Request updates dependency [mocha](https://github.com/mochajs/mocha) from `~5.1.0` to `~5.2.0`



<details>
<summary>Release Notes</summary>

### [`v5.2.0`](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#&#8203;520--2018-05-18)
[Compare Source](mochajs/mocha@v5.1.1...v5.2.0)
#### 🎉 Enhancements

- [#&#8203;3375]: Add support for comments in `mocha.opts` ([@&#8203;plroebuck])
#### 🐛 Fixes

- [#&#8203;3346]: Exit correctly from `before` hooks when using `--bail` ([@&#8203;outsideris])
#### 📖 Documentation

- [#&#8203;3328]: Mocha-flavored [API docs](https://mochajs.org/api/)! ([@&#8203;Munter])
#### 🔩 Other

- [#&#8203;3330]: Use `Buffer.from()` ([@&#8203;harrysarson])
- [#&#8203;3295]: Remove redundant folder ([@&#8203;DavNej])
- [#&#8203;3356](`https://github.com/mochajs/mocha/pull/3356`): Refactoring ([@&#8203;plroebuck])

[#&#8203;3375]: `https://github.com/mochajs/mocha/pull/3375`
[#&#8203;3346]: `https://github.com/mochajs/mocha/pull/3346`
[#&#8203;3328]: `https://github.com/mochajs/mocha/pull/3328`
[#&#8203;3330]: `https://github.com/mochajs/mocha/pull/3330`
[#&#8203;3295]: `https://github.com/mochajs/mocha/pull/3295`

[@&#8203;plroebuck]: https://github.com/plroebuck
[@&#8203;harrysarson]: https://github.com/harrysarson
[@&#8203;outsideris]: https://github.com/outsideris
[@&#8203;Munter]: https://github.com/Munter

---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants