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.

Sign up for GitHub

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

Jump to bottom

Code documentation and plugin for building #7

Open
mwmitchell opened this issue Oct 5, 2014 · 1 comment
Open

Code documentation and plugin for building #7

mwmitchell opened this issue Oct 5, 2014 · 1 comment
Labels
enhancement

Comments

@mwmitchell
Copy link
Owner

Currently, Flux lacks documentation on its code/functions. Because of this, there's no way to build docs dynamically. Any public function/namespace within Flux should be documented with a doc string. Something like marginalia [1] could then be used for publishing docs.

  1. https://github.com/gdeer81/marginalia
@mwmitchell
Copy link
Owner Author

Codox is another documentation system to checkout: https://github.com/weavejester/codox

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mwmitchell