yard-api 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e7c2eba4abe4ecd107cc9cc902e36c05e5816e9
-  data.tar.gz: bc34644b9a32d557a6863d6e316d2e1c9bfd70b1
+  metadata.gz: dac4ffe3bb1f27996a4b7a8254976e53914e8f56
+  data.tar.gz: cc9172e66ddc41ee29c4e524241c011e94e47e74
 SHA512:
-  metadata.gz: d0abfc99e7f6d40e331219a96f5813b8a716d0fb7c78d0fc683543c6231053991833fec5450ca604deafa0ce7b55ec2618acd01336ec3480df3e250d2cb792e4
-  data.tar.gz: 3324e947fa1ed339a7cc8f9ca90d019a561fca7a4a6b2e3cbc099d2645112cb1a354549e18ebe6269d8a2cc89d1dee78f314293595b69311ae5926cd92217e27
+  metadata.gz: 6e253215dfd08a10c0a80b92f44b0d2f3f9ea7b1d60782a2ee3b569dac08e4cb4e331eefee265235dcbb6d140e40a06b9184b81e66258964b3238c324a397870
+  data.tar.gz: b2cee8fb44be95d68d2a172a8df616426155313ba5024940c7f8bdab25efde6ff17792260e334f618b918733328e054aee572f9e5f915dbca6ef07ec280a597d

data/config/yard_api.yml

@@ -0,0 +1,86 @@
+---
+# config/yard_api.yml
+output: public/doc/api
+source: doc/api
+readme: doc/api/README.md
+
+# Title of the project. This will be displayed in the browser title bar as well
+# as in the layout as the primary heading.
+title: Rails API Project
+
+# The resource index is a mega-index page that contains all the API resources.
+resource_index: true
+
+# Generate a single page that contains all the static pages and API resources.
+# The output will be a single file.
+#
+# Implies "resource_index" is true.
+one_file: false
+
+# YARD options passed as-is.
+#
+# If you want to use github-flavored markdown, use "redcparet" as a markup
+# provider, and "markdown" as a markup and add the following gems to your
+# Gemfile *before* yard-api:
+#
+#   - "github-markup"
+#   - "redcarpet"
+markup:
+markup_provider:
+
+# The API files to extract the docs from.
+files:
+  - app/controllers/**/*.rb
+
+# YARD assets that you want to reference from your docs. The key is the
+# reference key you use in the docs, while the value is the path to where
+# the assets are located relative to the doc source.
+#
+# These folders will be copied to the output directory.
+#
+# See "source" and "output".
+assets:
+  images: images
+  examples: examples
+
+# Debug option. YARD and YARD-API verbosity option.
+verbose: true
+
+# Debug option, will write *a lot* of stuff to STDOUT while generating.
+debug: false
+
+# Don't tolerate any errors such as bad asset paths, invalid tag properties, etc.
+strict: false
+
+# Each API endpoint details can provide a link to the source code of the
+# controller method if it's available on GitHub.
+#
+# Just specify the url to your repository and the branch the documentation has
+# been generated for and things "should work".
+github_url: https://github.com/amireh/yard-api
+github_branch: master
+
+# Set to true if you want @argument tags to show up in a table instead of a list.
+tabular_arguments: false
+
+# When this option is set, all @argument tags that do not explicitly specify
+# whether they are required or optional will be marked as required. Examples:
+#
+#   - @argument [String] name # assumed to be required
+#   - @argument [Optional, String] name # is now optional
+#   - @argument [Required, String] name # same effect if `strict_arguments` is true
+#
+# Conversely, leaving this to false marks all arguments with no specifier as
+# optional.
+strict_arguments: true
+
+# Width of the sidebar, in pixels.
+sidebar_width: 240
+
+# Width of the content box in pixels, or "fluid" for maximum screen space.
+#
+# Content will never overlap with the sidebar.
+content_width: "fluid"
+
+# Whitespace between the Sidebar and the content, in pixels.
+spacer: 20

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

data/yard-api.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Ahmad Amireh"]
   s.email       = 'ahmad@instructure.com'
   s.homepage    = 'https://github.com/amireh/yard-api'
-  s.files       = Dir.glob("{lib,spec,templates,tasks}/**/*.{rb,erb,rake}") +
+  s.files       = Dir.glob("{config,lib,spec,templates,tasks}/**/*.{yml,rb,erb,rake}") +
                   ['LICENSE', 'README.md', '.rspec', __FILE__]
   s.has_rdoc    = 'yard'
   s.license     = 'AGPL3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ahmad Amireh
@@ -76,6 +76,7 @@ files:
 - ".rspec"
 - LICENSE
 - README.md
+- config/yard_api.yml
 - lib/yard-api.rb
 - lib/yard-api/markup/redcarpet.rb
 - lib/yard-api/options.rb