From 61428b1caa09cda515deffda79ad45599814a9aa Mon Sep 17 00:00:00 2001 From: Stephen Paulger Date: Mon, 14 Jul 2014 11:32:08 +0100 Subject: [PATCH 1/2] Newer version of the Django docs The 1.3 version previously linked to has a big warning that it's an insecure deprecated version and there have probably been many improvements to the docs since 1.3, so I've changed the link to 1.6, the latest stable release. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2267224..72d4ae1 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This should be updated fairly regularly. As usual, **pull requests are encourage * [Riak Pipe README](https://github.com/basho/riak_pipe) - The simplicity of READMEs means that you can't obscure shitty content with flashy design. This one is written by my Basho colleague [Bryan Fink](https://twitter.com/#!/hobbyist) and should be committed to memory as an excellent example of how to write READMEs. * [Learn You Some Erlang](http://learnyousomeerlang.com/) (contributed by [@lenary](https://twitter.com/lenary)) (It should also be noted that LYSE was inspired by Miran Lipovača's [Learn You A Haskell](http://learnyouahaskell.com/).) * [CoreOS](http://coreos.com/docs/) Primary-colored goodness and a distributed system to boot (contributed by [@lucperkins](https://twitter.com/lucperkins)) -* [Django Documentation](https://docs.djangoproject.com/en/1.3/) (contributed by [@bretthoerner](https://twitter.com/bretthoerner)) +* [Django Documentation](https://docs.djangoproject.com/en/1.6/) (contributed by [@bretthoerner](https://twitter.com/bretthoerner)) * [Erldocs.com](http://erldocs.com/) (contributed by [@bradfordw](https://twitter.com/#!/bradfordw)) * [Clojuredocs.org](http://clojuredocs.org) (contributed by [@mrb_bk](https://twitter.com/#!/mrb_bk)) * [FreeBSD Handbook](http://www.freebsd.org/handbook/) - Clean and direct documentation of an OS. (contributed by [@mrtazz](https://twitter.com/#!/mrtazz)) From 9e079db11628b558d638a2155dd3d7d75744496c Mon Sep 17 00:00:00 2001 From: Stephen Paulger Date: Mon, 14 Jul 2014 11:36:56 +0100 Subject: [PATCH 2/2] Add read the docs. Read the docs hosts many projects using a Sphinx backend and is definitely worthy of being in the list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 72d4ae1..59f16db 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ This should be updated fairly regularly. As usual, **pull requests are encourage * [docco](http://jashkenas.github.com/docco/) - Pretty docs from source code comments with ports for many languages. (contributed by [@kylewest](https://twitter.com/kylewest)) * [DocumentUp](http://documentup.com/) - Instantly beautify your Github repositories' `README.md`. (contributed by [@kylewest](https://twitter.com/kylewest)) * [Sphinx](http://sphinx.pocoo.org/) - Comprehensive documentation tool using restructuredText with beautiful HTML and PDF output. (contributed by [@nikhilcutshort](https://twitter.com/nikhilcutshort)) +* [Read the Docs](https://readthedocs.org/) - Hosted docs using Sphinx, supports translations and finding docs for specific software versions. Used the Django Docs (contributed by [Stephen Paulger](https://github.com/stephenpaulger)) * [dr.js](https://github.com/adobe-webplatform/dr.js) - Tiny JavaScript documentation generator from the author of RaphaëlJS. (contributed by [@nikhilcutshort](https://twitter.com/nikhilcutshort)) * [Markdoc](http://markdoc.org/) - Lightweight documentation/wiki generator in Python, released in the [public domain](http://unlicense.org/). (contributed by [Neelfyn](http://neelfyn.info/)) * [ApiGen](http://apigen.org/) - Creates clean API documentation from PHP source code (contributed by [bryceadams](http://bryce.se/))