[Phpmyadmin-devel] Documentation

[Michal Čihař]

Dne Fri, 09 Nov 2012 12:16:08 -0500
Marc Delisle <marc at infomarc.info> napsal(a):

> Michal Čihař a écrit :
> > Hi
> > 
> > Dne Thu, 8 Nov 2012 17:32:41 +0100
> > Michal Čihař <michal at cihar.com> napsal(a):
> > 
> >> I've spent some more time to convert basically all our docs into
> >> Sphinx <http://sphinx.pocoo.org/> format. I know the conversion right
> >> now has messed up some parts, but that's quite easy to fix in future
> >> in case we decide to use it (I think that broken bits are easier to
> >> fix manually than torturing more the conversion script).
> > 
> > Most of the issues should be now fixed, I believe the new docs is ready
> > to be used.
> > 
> > Please check https://phpmyadmin.readthedocs.org [*] if you don't see any
> > major problems.
> > 
> > The question is whether we want to keep documentation in same
> > repository as code or keep it separately. The same question applies for
> > translations of documentation.
> 
> I see a reason to keep doc and translations in the same repository as 
> the code: when you want to "git grep" for a configuration directive or 
> for a specific message.

Indeed I see this as an advantage as well.

-- 
	Michal Čihař | http://cihar.com | http://phpmyadmin.net
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: not available
URL: <http://lists.phpmyadmin.net/pipermail/developers/attachments/20121109/6dc8e27f/attachment.sig>