Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Enables Pygments syntax highlighting in YARD via pygments.rb

Resources

Stars

0 stars

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages