On 19 May 2014 22:59, Pyfisch <[email protected]> wrote:

> Sphinx can generate really good docs from the source code and you only
> need to change source code, and then we could generate and host the docs on
> the labs server. If we require to update mediawiki.org, we wont ever
> reach sync between code and documentation. I propose to remove the
> documentation on mediawiki and only use sphinx for docs, but everywhere.
>

Recently, I've been thinking a lot about this, so this was a good reason to
write those thoughts down; I created a wiki page for that:

https://www.mediawiki.org/wiki/Help:Pywikibot/Documentation_RFC

Basically, I'm not a big fan of sphinx because of the lack of accessibility
(and I *loathe* restructuredtext), and we lose e.g. translations when we
switch, so I would prefer something centered around mw.org. However, I *do*
agree it's a huge issue that code and docs are never in sync. Anyway, see
the not-yet-a-real-RFC for my thoughts.

Merlijn
_______________________________________________
Pywikipedia-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikipedia-l

Reply via email to