{"action":"created","issue":{"url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/22","labels_url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/22/labels{/name}","comments_url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/22/comments","events_url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/22/events","html_url":"https://github.com/jdantonio/functional-ruby/pull/22","id":58516006,"number":22,"title":"Fix markdown files embedding in documentation","user":{"login":"rranelli","id":4231743,"avatar_url":"https://avatars.githubusercontent.com/u/4231743?v=3","gravatar_id":"","url":"https://api.github.com/users/rranelli","html_url":"https://github.com/rranelli","followers_url":"https://api.github.com/users/rranelli/followers","following_url":"https://api.github.com/users/rranelli/following{/other_user}","gists_url":"https://api.github.com/users/rranelli/gists{/gist_id}","starred_url":"https://api.github.com/users/rranelli/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rranelli/subscriptions","organizations_url":"https://api.github.com/users/rranelli/orgs","repos_url":"https://api.github.com/users/rranelli/repos","events_url":"https://api.github.com/users/rranelli/events{/privacy}","received_events_url":"https://api.github.com/users/rranelli/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":13,"created_at":"2015-02-22T20:03:46Z","updated_at":"2015-03-06T12:21:29Z","closed_at":"2015-02-23T14:32:17Z","pull_request":{"url":"https://api.github.com/repos/jdantonio/functional-ruby/pulls/22","html_url":"https://github.com/jdantonio/functional-ruby/pull/22","diff_url":"https://github.com/jdantonio/functional-ruby/pull/22.diff","patch_url":"https://github.com/jdantonio/functional-ruby/pull/22.patch"},"body":"(there is a lot of trailling whitespace remotion. Sorry, my editor does this automatically)\r\n\r\nI've noticed that the macro directives in the documentations are not being expanded.\r\n\r\nFor example, the documentation for the `PatternMatching` module [here](http://www.rubydoc.info/github/jdantonio/functional-ruby/master/Functional/PatternMatching) does not include the contents of the `pattern_matching` macro defined in the [md doc file](./doc/pattern-matching.md).\r\n\r\nWhen I'm running `bundle exec yard` in my machine I get:\r\n\r\n```\r\n[warn]: Syntax error in `doc/memo.md`:(10,58): syntax error, unexpected ')', expecting end-of-inpu\r\nt                                                                                                \r\n[warn]: Invalid/missing macro name for Functional::Memo (lib/functional/memo.rb:20)\r\n[warn]: Invalid/missing macro name for Functional::Delay (lib/functional/delay.rb:23)\r\n[warn]: Invalid/missing macro name for Functional::Union (lib/functional/union.rb:58)\r\n[warn]: Invalid/missing macro name for Functional::Tuple (lib/functional/tuple.rb:24)\r\n[warn]: Invalid/missing macro name for Functional::Record (lib/functional/record.rb:28)\r\n[warn]: Invalid/missing macro name for Functional::Record (lib/functional/record.rb:28)\r\n[warn]: Invalid/missing macro name for Functional::Option (lib/functional/option.rb:23)\r\n[warn]: Invalid/missing macro name for Functional::Either (lib/functional/either.rb:83)\r\n[warn]: Invalid/missing macro name for Functional::Protocol (lib/functional/protocol.rb:62)\r\n[warn]: Invalid/missing macro name for Functional::FinalVar (lib/functional/final_var.rb:39)\r\n[warn]: Invalid/missing macro name for Functional::FinalStruct (lib/functional/final_struct.rb:51)\r\n[warn]: Invalid/missing macro name for Functional::ValueStruct (lib/functional/value_struct.rb:28)\r\n[warn]: Invalid/missing macro name for Functional::PatternMatching (lib/functional/pattern_matchin\r\ng.rb:15)                                                                                         \r\nFiles:          19\r\nModules:         8 (    0 undocumented)\r\nClasses:         8 (    0 undocumented)\r\nConstants:       5 (    0 undocumented)\r\nMethods:       114 (    0 undocumented)\r\n 100.00% documented\r\n```\r\n\r\nI realized that the file `memo.md` did not contain the macro declaration `@!macro [new] memoize`. I have added and syntax error in the yard output disappeared.\r\n\r\nThe `.yardopts` file contained the line `./doc/**/*.txt` that probably should've been `./doc/**/*.md`.\r\nI have changed it to `./doc/**/*.md` but the problem continued the same.\r\n\r\nI tried to find information on how to declare macros in markdown files but couldn't find any.\r\n\r\nAny other ideas?\r\n\r\nPs: I have also noticed that in [concurrent-ruby](http://github.com/jdantonio/concurrent-ruby) the markdown files are actually directly included, not macro-expanded. I have tested this approach and it (obviously) worked out fine. Should I go for it?\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/comments/77551032","html_url":"https://github.com/jdantonio/functional-ruby/pull/22#issuecomment-77551032","issue_url":"https://api.github.com/repos/jdantonio/functional-ruby/issues/22","id":77551032,"user":{"login":"jdantonio","id":173910,"avatar_url":"https://avatars.githubusercontent.com/u/173910?v=3","gravatar_id":"","url":"https://api.github.com/users/jdantonio","html_url":"https://github.com/jdantonio","followers_url":"https://api.github.com/users/jdantonio/followers","following_url":"https://api.github.com/users/jdantonio/following{/other_user}","gists_url":"https://api.github.com/users/jdantonio/gists{/gist_id}","starred_url":"https://api.github.com/users/jdantonio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jdantonio/subscriptions","organizations_url":"https://api.github.com/users/jdantonio/orgs","repos_url":"https://api.github.com/users/jdantonio/repos","events_url":"https://api.github.com/users/jdantonio/events{/privacy}","received_events_url":"https://api.github.com/users/jdantonio/received_events","type":"User","site_admin":false},"created_at":"2015-03-06T12:21:29Z","updated_at":"2015-03-06T12:21:29Z","body":"@rranelli Are you still interested in trying to setup yardoc on GitHub Pages? I need to do the same things for `thread_safe` (see [here](https://github.com/ruby-concurrency/thread_safe/issues/6)). Would you be interested in working on that?"}}