Ramaze / ramaze

Ramaze is a simple, light and modular open-source web application framework written in Ruby.
http://ramaze.net
371 stars 37 forks source link

Empty code listings in documentation #72

Closed janpieper closed 10 years ago

janpieper commented 11 years ago

Examples

1) http://ramaze.net/documentation/index.html

Installing Ramaze is as easy as the following command:

For more information see the chapter Installation.

but the README.md says:

Installing Ramaze is as easy as the following command:

$ gem install ramaze

For more information see the chapter {file:installation Installation}.

2) http://ramaze.net/documentation/file.installation.html

Ramaze can be installed by using Rubygems, direct download or by using Git. Installing Ramaze via Rubygems only needs a single command:

Optionally you can specify -v to install a specific version:

but if you check guide/general/installation.md there is:

Ramaze can be installed by using [Rubygems][rubygems], direct download or by
using Git. Installing Ramaze via Rubygems only needs a single command:

    $ gem install ramaze

Optionally you can specify ``-v`` to install a specific version:

    $ gem install ramaze -v 2011.07.25

3) ...

There are many more empty code listings. It seems to be a generic problem with your documentation generator.

leucos commented 11 years ago

Seems that yard doesn't like '$' anymore with ruby 2. There's an open ticket for yard on this : https://github.com/lsegal/yard/issues/702 @YorickPeterse or @manveru could you regenerate the doc with 1.9.3 on the website in the meantime ?

dhoppe commented 10 years ago

This issue has already been solved by commit Isegal/yard@c84bfb316a2c16df403e339d89fa55df8a40cd33. Could @manveru or @YorickPeterse regenerate the docs, please? It is a little bit complicated to learn Ramaze, without working code examples.

Generating docs based on Ruby 1.9.3 or 2.1.0 and Yard 0.8.7.3 works like a charm.

manveru commented 10 years ago

OK, deployed the site again, docs should be better now.