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

Automatize documentation #9

Open
cosenal opened this issue Jan 22, 2015 · 0 comments
Open

Automatize documentation #9

cosenal opened this issue Jan 22, 2015 · 0 comments

Comments

@cosenal
Copy link
Contributor

cosenal commented Jan 22, 2015

First of all, thanks a lot for documenting LocalDistinguishability on the wiki.

In an ideal workflow, documentation should go hand by hand with the code, that is, there should be documentation changes in each Pull Request where you change the signature of the functions in the code. I am opening this issue to discuss a way to automatize documentation.

As we discussed by email, this is not a priority, but I believe it's still good to write down potential solutions:

  • Mediawiki as it is now (source on Github)
  • MATLAB documentation hosted on Github Pages
    • free hosting
  • readme.io
    • free for open source projects

(more pro and cons to be added)

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

No branches or pull requests

1 participant