burtlo / yard-cucumber

YARD extension that adds Cucumber Features, Tags, and Step Definitions
MIT License
129 stars 46 forks source link

yard server - can't get features in doc #24

Closed maxigit closed 12 years ago

maxigit commented 12 years ago

Hi , I'm trying to use yard-cucumber It seems to generate the doc ok (scenarios and steps seems to be in .yardoc/objects/root.data) also I need to add yard-cucumber' int theautoload_plugin` section, but when I launch the server the features (and the other ones) tab are empty.

burtlo commented 12 years ago

To be honest, you got me. I have not thoroughly looked at yard server since the 7.0.0 release. I will have to take some time to look at this to see what is required to get this to work.

maxigit commented 12 years ago

Does the server need to be 'patched' somehow ? Should I try installing cucumber-in-the-yard to run the server ?

burtlo commented 12 years ago

I think I need to look at the yard-server code again and make sure I am putting the right override hooks in it to make it recognize features.

Yard-server is still not quite as straightforward as performing this just for yardoc.

Sent from my iPhone.

On Oct 5, 2011, at 3:06 AM, Maxime Bourgetreply@reply.github.com wrote:

Does the server need to be 'patched' somehow ? Should I try installing cucumber-in-the-yard to run the server ?

Reply to this email directly or view it on GitHub: https://github.com/burtlo/yard-cucumber/issues/24#issuecomment-2296342

msolovyov commented 12 years ago

I'm running into the same issue.

Followed the install instructions and when running the yardoc command to generate docs for features I get this:

yardoc 'features/*/.feature' Files: 20 Modules: 0 ( 0 undocumented) Classes: 0 ( 0 undocumented) Constants: 0 ( 0 undocumented) Methods: 0 ( 0 undocumented) NaN% documented

Does this mean it's not picking up on the yard-cucumber plugin at all, or just not when running yard-server?

burtlo commented 12 years ago

@msolovyov try just creating a local yardoc version of your project. If you have the plugin installed correctly it will generate the feature files for you.

msolovyov commented 12 years ago

The menu's for the features works now when opening up the docs locally. But it's not picking up the actual feature files. Viewing a 'No Features Defined' message when at the requirements.html

I've run 'gem install yard-cucumber' and 'yard config load_plugins true' then 'rm -rf .yardoc && yard doc' inside my project directory. What am I missing? I can see documentation for my other classes just fine.

msolovyov commented 12 years ago

I fixed my issue by adding - yard-cucumber to the .yard/config file in the autoload_plugins section and by also adding yard and yard-cucumber to my gemfile.

Now my rake task generates the feature docs. Cheers

maxigit commented 12 years ago

I added the yard-cucumber to the .yard/config file too and that generate the features in doc. However I still can't see anything when I run the server. I can see Features and Steps tab, but they are empty, although there definitely something in the yardoc files.

burtlo commented 12 years ago

@msolovyov and @maxigit I'm glad you got the feature files to work locally. I will look at addressing the yard server issue this week.

nikosd commented 12 years ago

+1 for a fix :)

burtlo commented 12 years ago

Finally got around to fixing this issue. It was mistakes on my part to prepare yard-cucumber for yard 0.7.0 release with the new way to incorporate js and css files that I forgot that yard-server was going to need to include the renamed files.

Should be fixed and working with stylesheets and js. Give version 2.1.6 a try.

maxigit commented 12 years ago

That works now, thanks