Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Auto generate API.md using mocha #105

Closed
wants to merge 4 commits into from

Conversation

dignifiedquire
Copy link
Contributor

Found a nice way to generate docs from tests, maybe we can combine this with #104

@dignifiedquire
Copy link
Contributor Author

cc @victorbjelkholm @RichardLitt

@victorb
Copy link
Contributor

victorb commented Nov 6, 2015

Oh, that does sound awesome! So we can have really clear and focused tests (better for development) that we also can use to generate the API.md? Sounds to good to be true! :)

@harlantwood
Copy link
Contributor

so very excellent 👍

@RichardLitt
Copy link
Contributor

This looks pretty awesome! This just grabs it from the tests file?

@RichardLitt
Copy link
Contributor

How do I access this file: test/tmp-disposable-nodes-addrs.json?

@dignifiedquire
Copy link
Contributor Author

@RichardLitt not sure what you mean with "access"

@RichardLitt
Copy link
Contributor

I mean I don't have that file, and it's in the .gitignore. Am I missing something I ought to be doing to create it?

🐕  gulp mocha
[10:02:35] Using gulpfile ~/src/js-ipfs-api/gulpfile.js
[10:02:35] Starting 'mocha'...
module.js:339
    throw err;
    ^

Error: Cannot find module './tmp-disposable-nodes-addrs.json'

@daviddias
Copy link
Contributor

@dignifiedquire could you make this PR be a PR from a branch on this repo, please? thank you :)

@dignifiedquire
Copy link
Contributor Author

@diasdavid done

@dignifiedquire dignifiedquire deleted the auto-docs branch November 24, 2015 18:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants