Yourlabs

documentation

Build beautiful books with Git and MarkDown with GitBook

| by jpic | git documentation
GitBook looks promising, see how classy that Javascript book build with GitBook is !

Using rst for documentation on both GitHub and Sphinx/RTFD: code-block tip

| by jpic | python documentation service
Good documentation should be readable from source, and usable to generate fancy HTML. That's why RST is so commonly used: readable as text source, usable to generate HTML and even PDF GitHub knows how to render it, Sphinx and ReadTheDocs know how to render it. Good documentation should often show code. This article demonstrates an inconsistency between RTFD and GitHub rendering, and how to fix it. As far as sphinx is concerned, the default highlight language for code blocks is Python. Read More
1 of 1