Extension:ModDoc

MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
ModDoc
Release status: experimental
Wikimedia Technical Conference191113 - 50.jpg
Implementation API
Description Provides Lua documentation for Scribunto.
Author(s)
  • John Erling Blad (Jebladtalk)
Compatibility policy Master maintains backward compatibility.
MediaWiki
Database changes No
License GNU General Public License 2.0 or later
Download
README, LDoc
Translate the ModDoc extension

Check usage and version matrix.

This extension is a reimplementation of w:Module:LuaDoc, and is still under development!

ModDoc provides a framework for Lua documentation.

InstallationEdit

ModDoc depends on modules from the LuaLexer (still pending) and Scribunto extensions.

  • Download and place the file(s) in a directory called ModDoc in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ModDoc' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

UsageEdit

For further help, see the generated ModDoc documentation.

DevelopmentEdit

For recreating the Vagrant-based development environment, see ModDoc: Topics/Vagrant.

See alsoEdit

External linksEdit