Project

yard-xml

0.0
No commit activity in last 3 years
No release in over 3 years
This plugin allows to render YARD documentation into the single XML file for further processing.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

YardXML: an YARD extension for XML output

YardXML is an YARD extension which allows to produce XML output from YARD registry.

Usage

Install the gem:

gem install yard-xml

Edit ~/.yard/config and insert the following line:

load_plugins: true

Run yardoc with -f xml switch to specify XML format.

yard -f xml

It will generate doc/index.xml file for you.