[phpMyAdmin Developers] sql-parser documentation

[Michal Čihař]

Hi

Dne 7.3.2016 v 15:50 Isaac Bennetch napsal(a):
> What format for documentation do you feel would be best for the
> sql-parser library?
> 
> We could do the .rst format that phpMyAdmin uses, or we could use
> MarkDown which would be directly interpreted by Github. I'm rather
> indifferent about it, and since it's going to be for developers rather
> than end users we might want to go a different direction.

The main motivation for rst used in phpMyAdmin was readthedocs.org service.

> Any opinions about this?

There doesn't seem to be any widely used standard for documenting PHP
libraries.

While thinking about this topic. Maybe we can look for something that
can do API documentation together with some generic developer one and
use it for all our code? The phpDox which is currently used for
https://develdocs.phpmyadmin.net/ kind of works, but I miss some
features like searching or better look...

-- 
	Michal Čihař | http://cihar.com | http://blog.cihar.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: OpenPGP digital signature
URL: <https://lists.phpmyadmin.net/pipermail/developers/attachments/20160307/a1b8c867/attachment.sig>