jro_apps/redmine Files · lib/tasks/yardoc.rake

Add static docs to YARD....

Add static docs to YARD. git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3922 e93f8b46-1217-0410-a6f0-8f06a7374b81

Eric Davis - - Load All Authors

File last commit:

r3808:2e14ba95a034


                r3808:2e14ba95a034

Download file

             yardoc.rake
        
                    21 lines
            
             | 578 B
            
                | text/x-ruby
            
             |
                RubyLexer
            
             / lib / tasks / yardoc.rake
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      begin

        require 'yard'

        YARD::Rake::YardocTask.new do |t|

          files = ['lib/**/*.rb', 'app/**/*.rb']

          files << Dir['vendor/plugins/**/*.rb'].reject {|f| f.match(/test/) } # Exclude test files

          t.files = files

          static_files = ['doc/CHANGELOG',

                          'doc/COPYING',

                          'doc/INSTALL',

                          'doc/RUNNING_TESTS',

                          'doc/UPGRADING'].join(',')

          t.options += ['--output-dir', './doc/app', '--files', static_files]

        end

      rescue LoadError

        # yard not installed (gem install yard)

        # http://yardoc.org

      end

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				begin
				require 'yard'

				YARD::Rake::YardocTask.new do \|t\|
				files = ['lib/*/.rb', 'app/*/.rb']
				files << Dir['vendor/plugins/*/.rb'].reject {\|f\| f.match(/test/) } # Exclude test files
				t.files = files

				static_files = ['doc/CHANGELOG',
				'doc/COPYING',
				'doc/INSTALL',
				'doc/RUNNING_TESTS',
				'doc/UPGRADING'].join(',')

				t.options += ['--output-dir', './doc/app', '--files', static_files]
				end

				rescue LoadError
				# yard not installed (gem install yard)
				# http://yardoc.org
				end