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

Documentation engine #1

Open
macobo opened this issue Aug 24, 2013 · 3 comments
Open

Documentation engine #1

macobo opened this issue Aug 24, 2013 · 3 comments

Comments

@macobo
Copy link
Owner

macobo commented Aug 24, 2013

There's currently almost no docs. Write some!

From https://github.com/PharkMillups/beautiful-docs it seems that either Sphinx or http://documentup.com/ would be good candidates. Experiment with those.

@macobo
Copy link
Owner Author

macobo commented Aug 27, 2013

With sphinx https://readthedocs.org/ would be a great option, albeit a little overblown perhaps.

@aivarannamaa
Copy link

What about Github + Markdown? ;)

@macobo
Copy link
Owner Author

macobo commented Aug 29, 2013

This is basically the documentup option, but I have a dislike for long READMEs without navigation on the side. The result would be hosted on GH anyways (gh-pages).

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

No branches or pull requests

2 participants