Hi Merlijn,
Merlijn van Deen schreef op 20-5-2014 22:14:
On 19 May 2014 22:59, Pyfisch
<pyfisch(a)googlemail.com
<mailto:pyfisch@googlemail.com>> 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 <http://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 Good overview!
Maybe something to take into account: We have different
groups of users for the documentation:
1. People who just want to install pywiki and run scripts
2. People who want to mess with the code
Maybe you want the first part to be more based onwiki and the second
part more in code. If we start talking about structure: Why do we have
different namespaces and subpages on MediaWiki.org? Makes it quite hard
to find stuff.
Maarten