lupinotech/yard-mediawiki

Template for Yardoc to output files in (Semantic) Mediawiki syntax

yard-mediawiki

This is a work-in-progress!

NO NOT USE YET!

Template for Yardoc to output files in (Semantic) Mediawiki syntax

Sumary

yard-mediawiki is a template for YARD derived from the default HTML output template. It writes the documentation into .mw files which can be exported into any MediaWiki instance.

As of now, the template still prints mostly HTML.

Usage

Download and store the template files somewhere on your system.

Add

gem 'yard-mediawiki', path: "<path_to>/yard-mediawiki/"

to the Gemfile of your project, and then run bundle update yard-mediawiki Then you can generate the documentation of your code with Mediawiki markup by using

bundle exec yard doc

with the repo's "yard-mediawiki.rb" as plugin (--plugin), "mediawiki" as template name (-t) and "mwtext" (-f) as output format, e.g.:

bundle exec yard doc --plugin <path_to>/yard-mediawiki/yard-mediawiki.rb -t mediawiki -f mwtext -o <path_to_output> <additional_options> <path_to_input>

Additional Options

• --mw-namespace=<namespace> Namespace that is added to cross references and internal links (default: empty)
• --[no-]mw_semantic Whether or not Semantic Mediawiki's properties are used (default: --no-ms-semantic)

License

see LICENSE file in the repo's base directory.