OdifYltsaeb / django-multilingual

Automatically exported from code.google.com/p/django-multilingual
MIT License
0 stars 0 forks source link

No documentation #75

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
There is no documentation other than some pages in the wiki. Not enough.
Sooner or later, wiki pages won't be in sync with the documentation. People
will be saying "the docs say this and that" and the reply will be "ah,
yes, this is old information, this was fixed then and then, don't read
that page, read the other page, which by the way is also a bit
outdated" and so on. The documentation should be in the svn, and each
check-in should also include, if applicable, changes to the
documentation as part of the patch. I propose a docs directory, with the
documentation contained in there in restructuredText/Sphinx format. I can
start to do it if there is agreement.

Original issue reported on code.google.com by achristo...@gmail.com on 19 Nov 2008 at 1:29

GoogleCodeExporter commented 8 years ago
I had started writing this doc (mostly a copy of the wiki) way back with 
Marcin, but
it fell through (as it usually happens!).

So, here's the patch for now, and a link to the built documentation, in sync

http://panos.solhost.org/django-multilingual/

Original comment by panos.la...@gmail.com on 11 Dec 2009 at 9:07

Attachments:

GoogleCodeExporter commented 8 years ago
Disregard the above patch and link.

We now have our very own Sphinx documentation, right on our repo, enjoy:

http://django-multilingual.googlecode.com/svn/trunk/docs/_build/html/

Thank Marcin for allowing me to handle this :)

Original comment by panos.la...@gmail.com on 15 Dec 2009 at 12:40

GoogleCodeExporter commented 8 years ago
Wow. Panos, thanks, this documentation rocks :)

Original comment by marcin.k...@gmail.com on 15 Dec 2009 at 12:43