yard-rest 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.markdown +1 -1
- data/VERSION +1 -1
- data/templates/default/layout/html/setup.rb +1 -1
- metadata +1 -1
data/README.markdown
CHANGED
|
@@ -25,7 +25,7 @@ When using yardoc you ask it to use the "rest" plugin (the --plugin option). For
|
|
|
25
25
|
|
|
26
26
|
When you want to make the API-documentation available for public use the following command:
|
|
27
27
|
|
|
28
|
-
bundle exec yardoc --plugin rest --title 'Our App's API' --output-dir ./public/api
|
|
28
|
+
bundle exec yardoc --plugin rest --title 'Our App's API' --readme "./doc/README_FOR_API" --output-dir ./public/api
|
|
29
29
|
|
|
30
30
|
## Gemfile functionality
|
|
31
31
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.4
|
|
@@ -22,7 +22,7 @@ def menu_lists
|
|
|
22
22
|
end
|
|
23
23
|
|
|
24
24
|
def index
|
|
25
|
-
path_to_readme =
|
|
25
|
+
path_to_readme = options[:readme]
|
|
26
26
|
@readme = YARD::CodeObjects::ExtraFileObject.new(path_to_readme) if File.exists?(path_to_readme)
|
|
27
27
|
@resources = index_objects(@objects)
|
|
28
28
|
erb(:index)
|