How does Akka do it's documentation?

[Paul Dale]

Howdy hAkkers,

I was wondering how Akka's documentation is generated?

It is really nicely done, and was wondering if the documentation
process has been made public?

If so, would someone be able to provide a link to where we would find it?

Thanks!
Paul

[Konrad Malawski]

Take a look at https://github.com/akka/akka/tree/master/akka-docs and the Makefile in there :-)

It's using http://sphinx-doc.org/invocation.html and the docs are written in reStructuredTest (rst for short http://docutils.sourceforge.net/rst.html).

I hope that helps :-)

-- 

Cheers,

Konrad Malawski

--

Read the docs: http://akka.io/docs/

Check the FAQ: http://akka.io/faq/

Search the archives: https://groups.google.com/group/akka-user

---

You received this message because you are subscribed to the Google Groups "Akka User List" group.

To post to this group, send email to akka...@googlegroups.com.

To unsubscribe from this group, send email to akka-user+...@googlegroups.com.

Visit this group at http://groups.google.com/group/akka-user?hl=en.

[Paul Dale]

Thanks!

[Jonas Bonér]

We have wrapped up all the doc goodness in a template project, as a kick starter for new projects. Just clone it and hack away.

https://github.com/typesafehub/doc-template

--
Jonas Bonér
CTO Typesafe - The software stack for applications that scale
Phone: +46 733 777 123
Twitter: @jboner

[Paul Dale]

Awesome. Thank Jonas!