Skip to content
This repository has been archived by the owner on Jul 31, 2018. It is now read-only.

Add an option to the binary that build docs automatically #19

Open
frankrousseau opened this issue Mar 17, 2014 · 4 comments
Open

Add an option to the binary that build docs automatically #19

frankrousseau opened this issue Mar 17, 2014 · 4 comments

Comments

@frankrousseau
Copy link
Contributor

A html doc of the produced api could be generated automatically for the routes files and the controller comments.

@ghost
Copy link

ghost commented Mar 17, 2014

I like this project, and am glad to see some activity on it. Will keep watching, and maybe help if I can.

@frankrousseau
Copy link
Contributor Author

Great news!

Some thoughts about this feature:

  • put all docs in one html file
  • todo: find a way to "mark" the documentation comments as special comments

@frankrousseau
Copy link
Contributor Author

I made a starting point that outputs the routes files structure as a markdown file.

https://github.com/mycozycloud/americano/blob/autodoc/bin/americano#L227-L255

It's in the autodoc branch.

@frankrousseau
Copy link
Contributor Author

That lib could help: https://github.com/marijnh/acorn/

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants