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

fix typo at lib/tasks/ci.rake...

fix typo at lib/tasks/ci.rake git-svn-id: http://svn.redmine.org/redmine/trunk@13094 e93f8b46-1217-0410-a6f0-8f06a7374b81

Eric Davis - - Load All Authors

File last commit:

r3808:2e14ba95a034


                r12819:8c5d88160f16

Download file

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

        Eric Davis
    
Added rake task to generate the yardoc (rake yard)...

              r3516
            
      begin

        require 'yard'

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

        Eric Davis
    
Exclude test files from YARD....

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

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

          t.files = files

        Eric Davis
    
Add static docs to YARD....

              r3808
            
          static_files = ['doc/CHANGELOG',

                          'doc/COPYING',

                          'doc/INSTALL',

                          'doc/RUNNING_TESTS',

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

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

        Eric Davis
    
Added rake task to generate the yardoc (rake yard)...

              r3516
            
        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

Eric Davis Added rake task to generate the yardoc (rake yard)...	r3516	begin
		require 'yard'

		YARD::Rake::YardocTask.new do \|t\|
Eric Davis Exclude test files from YARD....	r3806	files = ['lib/*/.rb', 'app/*/.rb']
		files << Dir['vendor/plugins/*/.rb'].reject {\|f\| f.match(/test/) } # Exclude test files
		t.files = files
Eric Davis Add static docs to YARD....	r3808
		static_files = ['doc/CHANGELOG',
		'doc/COPYING',
		'doc/INSTALL',
		'doc/RUNNING_TESTS',
		'doc/UPGRADING'].join(',')

		t.options += ['--output-dir', './doc/app', '--files', static_files]
Eric Davis Added rake task to generate the yardoc (rake yard)...	r3516	end

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