Page MenuHomePhabricator

Doxygen for MediaWiki branches
Closed, ResolvedPublic

Description

Right now we build MediaWiki doxygen docs at svn.wikimedia.org/doc/. This is built from trunk automatically via a cron.

It would be nice to have a stable version of the docs for the branches as well. If someone is writing an extension for 1.17, the trunk docs may be inaccurate if methods changed or were deprecated.

Something like svn.wikimedia.org/doc/1.17/, /doc/1.16/ etc would be nice.
Move trunk docs to /doc/trunk/
Make /doc/ a landing page.


Version: unspecified
Severity: enhancement

Details

Reference
bz26712

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 21 2014, 11:21 PM
bzimport set Reference to bz26712.

Chad, did you assign this to yourself? What's holding you up? (Here, have a tuit http://en.wiktionary.org/wiki/round_tuit.)

Yeah I assigned it to me :)

I just haven't had the chance to play with it yet. It was more a reminder than anything.

Yeah, at least these wouldn't need rebuilding every night, could just be done manually after backporting..

Be nice to decide how to do bug 25978, and have that in there aswell...

  • Bug 31159 has been marked as a duplicate of this bug. ***

olivier.beaton wrote:

sorry about that, having done a search for several keywords (mostly in MediaWiki->Documentation... why is this here?) let me put my support behind this and drop some more keywords like:

class reference

(In reply to comment #6)

sorry about that, having done a search for several keywords (mostly in
MediaWiki->Documentation... why is this here?) let me put my support behind
this and drop some more keywords like:

class reference

It's all hosted on the "subversion" server (though, that should be VCS now, as it's doing GIT too), but it's mostly a technical exercise, the documentation is effectively branched already by SVN, we just don't parse/display it anywhere, so hence, it's setting Doxygen pointing at the right paths and letting it generate the stuff

olivier.beaton wrote:

Could you please post the doxygen config so we can generate our own older docs?

Moving to testing infrastructure, since the eventual plan is to have jenkins generate these docs for us.

Fixed together for both master and other branches in bug 35663.