Enables Pygments syntax highlighting in YARD via pygments.rb
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
templates/default
.gitignore
Gemfile
README.md
Rakefile
yard-pygmentsrb.gemspec

README.md

yard-pygmentsrb

This gems borrows code from nex3's yard-pygments

yard-pygmentsrb enables the nice Pygments syntax highlighting in YARD, through pygments.rb.

Usage

Install the gem

gem install yard-pygmentsrb

Write some code blocks in your documentation

    !!!python
    def __call__(self, mom):
        pass

Tell YARD to generate docs using the plugin

yard --plugin pygmentsrb

And if you want YARD to always use it, write the --plugin pygmentsrb line to your .yardopts file

Requirements

None.

Obviously this gem requires YARD and pygments.rb, so you should have their requirements met.