Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rake docs:build no longer working? #3025

Closed
seanlinsley opened this issue Mar 27, 2014 · 1 comment
Closed

rake docs:build no longer working? #3025

seanlinsley opened this issue Mar 27, 2014 · 1 comment

Comments

@seanlinsley
Copy link
Contributor

We use rake docs:build to autogenerate the index-as-* documentation directly from the docstrings. As I discovered in ceb096c, it's no longer updating the files in docs/3-index-pages.

It's likely unrelated, but nonetheless ref #2124

The output from running rake yard (which should run docs:build at the end):

$ rake yard
[warn]: Unknown tag @returns in file `lib/active_admin/dsl.rb` near line 54
[warn]: Unknown tag @returns in file `lib/active_admin/namespace.rb` near line 116
[warn]: Unknown tag @returns in file `lib/active_admin/application.rb` near line 128
[warn]: Unknown tag @options in file `lib/active_admin/application.rb` near line 149
[warn]: Unknown tag @params in file `lib/active_admin/resource/routes.rb` near line 7
[warn]: Unknown tag @returns in file `lib/active_admin/authorization_adapter.rb` near line 53
[warn]: Unknown tag @returns in file `lib/active_admin/authorization_adapter.rb` near line 71
[warn]: Unknown tag @options in file `lib/active_admin/views/components/columns.rb` near line 119
[warn]: Unknown tag @returns in file `lib/active_admin/resource/page_presenters.rb` near line 36
[warn]: @param tag has unknown parameter name: attribute 
    in file `lib/active_admin/filters/resource_extension.rb' near line 49
[warn]: @param tag has unknown parameter name: status 
    in file `lib/active_admin/views/components/status_tag.rb' near line 33
[warn]: @param tag has unknown parameter name: type 
    in file `lib/active_admin/views/components/status_tag.rb' near line 33
[warn]: @param tag has unknown parameter name: options 
    in file `lib/active_admin/views/components/status_tag.rb' near line 33
[warn]: Unknown tag @returns in file `lib/active_admin/base_controller/authorization.rb` near line 55
[warn]: Unknown tag @returns in file `lib/active_admin/base_controller/authorization.rb` near line 72
[warn]: Unknown tag @returns in file `lib/active_admin/base_controller/authorization.rb` near line 91
[warn]: Unknown tag @returns in file `lib/active_admin/base_controller/authorization.rb` near line 99
[warn]: Unknown tag @returns in file `lib/active_admin/base_controller/authorization.rb` near line 115
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 29
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 47
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 85
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 102
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 115
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 134
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 143
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 154
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 170
[warn]: Unknown tag @returns in file `lib/active_admin/resource_controller/data_access.rb` near line 185
[warn]: Unknown tag @retruns in file `lib/active_admin/resource_controller/data_access.rb` near line 205
[warn]: Unknown tag @returns in file `lib/active_admin/batch_actions/resource_extension.rb` near line 45
[warn]: Unknown tag @returns in file `lib/active_admin/orm/active_record/comments/comment.rb` near line 16
[warn]: Syntax error in `lib/generators/active_admin/resource/templates/admin.rb`:(3,32): syntax error, unexpected '=', expecting end-of-input
[warn]: ParserSyntaxError: syntax error in `lib/generators/active_admin/resource/templates/admin.rb`:(3,32): syntax error, unexpected '=', expecting end-of-input
[warn]: Stack trace:
  gems/yard-0.8.7.4/lib/yard/parser/ruby/ruby_parser.rb:542:in `on_parse_error'
  gems/yard-0.8.7.4/lib/yard/parser/ruby/ruby_parser.rb:50:in `parse'
  gems/yard-0.8.7.4/lib/yard/parser/ruby/ruby_parser.rb:50:in `parse'
  gems/yard-0.8.7.4/lib/yard/parser/ruby/ruby_parser.rb:15:in `parse'
  gems/yard-0.8.7.4/lib/yard/parser/source_parser.rb:439:in `parse'
  gems/yard-0.8.7.4/lib/yard/parser/source_parser.rb:44:in `block in parse'

[warn]: In file `lib/active_admin/inputs/filter_select_input.rb':2: Cannot resolve link to association_primary_key from text:
[warn]: ...{association_primary_key}...
[warn]: In file `lib/active_admin/inputs/filter_select_input.rb':28: Cannot resolve link to association_primary_key from text:
[warn]: ...{association_primary_key}...
Files:         140
Modules:        77 (   68 undocumented)
Classes:       106 (   67 undocumented)
Constants:      20 (   16 undocumented)
Methods:       696 (  313 undocumented)
 48.39% documented
@timoschilling
Copy link
Member

rake yard invokes docs:build as expected after completion.

And after #3523 is merged we have a clean run too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants