[Qgis-community-team] [Qgis-psc] Doc writing: simpler writing and styling

[DelazJ]

Hi,
I found out that this discussion was pursued only in the psc mailing list (
http://lists.osgeo.org/pipermail/qgis-psc/2015-December/003781.html) though
it also concers documenters.
Please, keep sending messages to both lists.
Thanks.

2015-12-28 17:09 GMT+01:00 Richard Duivenvoorde <richard at duif.net>:

> On 27-12-15 22:35, Tim Sutton wrote:
>
> > Just bouncing the idea around: If we follow all this logic surely
> > it is better to switch to Markdown which is a lot more mainstream
> > and simple to pick up and use because of its cleaner syntax? I
> > guess with Markdown we lose the advantage of RST that  we do have:
> > richer syntax cross referencing, multi-chapter support, translation
> > support etc. ? Which of these are we still planning to keep?
>
> I'm not against using Markdown, but I'm not aware of any tooling
> around Markdown, for building and/or i18n stuff.
>
> So sphinx not only builds, but also helps us with:
> - doing i18n
> - templates for pages
> - references and indexes
> - pdf generatation
>
> I think at least the first 3 are essential for our documentation
> process, but others please let us know if we are wrong....
> Happy to switch, because some constructs (mainly the inline images)
> are just plain easier in Markdown, but after some googling, I think
> markdown is just not good enough for our usecase (i18n and indexes-wise)
>
> Some links:
>
> http://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-in
> stead-of-rst
>
> http://strapdownjs.com/
>
> Regards,
>
> Richard
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such
> as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20151231/847151ee/attachment.html>