smashing_docs 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b0e44e0f4ab5badf91ecddfefb2851bbac26f5
-  data.tar.gz: e7541a662104c2fce5e3e666fc9dc42189f2aa44
+  metadata.gz: 2273885225ce2b5c9814c5b84d15656801a9102c
+  data.tar.gz: 6f2daad5d6fa014ee9cdc06e4771bcee7cc21641
 SHA512:
-  metadata.gz: 0e2ff24eaa86feeb14762486a067f92f20226b2be8ed5d3d0c983e681cc573d406e46d3af8f25e7c49cda7e12d69ee1c40bc25924c53b7598492bf672abf1767
-  data.tar.gz: 79625ae7e3b62aa49b32b4954bd1c80b5f8eecf8a8857040bd850d22ccaf37191b971e9e29450ffbbf55f2c4075d854827b7d7cf74cb73a6e39c4e3670f625a6
+  metadata.gz: 1b09843efd0e3b0c004c7bf294166163217eaa0049b7e9c400b77b828009e84c74e7ad33c7a5574fdf695b0bb55fa0d479d59e4bcde4398065b2bcbf708d87b4
+  data.tar.gz: 48982149bc959da7efc80d9ffe4a7f670ed6b22724e7e9cf6fdd0d5426c3df9d1605f665fc0ccd68cb38229b0e4b934d42e439f4c16397eb902cd8d87e8c410b

data/README.md

@@ -35,14 +35,14 @@ Add this to your `rails_helper.rb` It should go outside of other blocks
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
-  c.auto_push     = false
   c.run_all       = true
+  c.auto_push     = false
 end
 ```
 
 Add the following content to `spec_helper.rb` inside the `RSpec.configure` block
 
-`config.after(:suite) { SmashingDocs.finish! }`
+`# config.after(:suite) { SmashingDocs.finish! }`
 
 It should look like this
 ```ruby
@@ -61,8 +61,8 @@ Set the `c.run_all` line to `false` in `rails_helper.rb`
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
-  c.auto_push     = false
   c.run_all       = false
+  c.auto_push     = false
 end
 ```
 
@@ -84,8 +84,8 @@ class ActiveSupport::TestCase
   SmashingDocs.config do |c|
     c.template_file = 'smashing_docs/template.md'
     c.output_file   = 'smashing_docs/api_docs.md'
-    c.auto_push     = false
     c.run_all       = true
+    c.auto_push     = false
   end
   # More code
 end
@@ -105,8 +105,8 @@ Set the `c.run_all` line to `false` in `test_helper.rb`
 SmashingDocs.config do |c|
   c.template_file = 'smashing_docs/template.md'
   c.output_file   = 'smashing_docs/api_docs.md'
-  c.auto_push     = false
   c.run_all       = false
+  c.auto_push     = false
 end
 ```
 
@@ -121,8 +121,8 @@ end
 
 ## Setting a template
 
-If you copied the code from above, SmashingDocs will look for a template file located in
-`smashing_docs/template.md`
+If you used the auto-installer or copied the code from above, SmashingDocs will
+look for a template file located in `smashing_docs/template.md`
 
 This template may be customized to fit your needs.
 
@@ -136,8 +136,9 @@ This template may be customized to fit your needs.
 
 ## Where to find the docs
 
-By default, the docs are output to `api_docs.md` in the root of the Rails project.
-You can change this by altering the config in `test_helper.rb` or `rails_helper.rb`.
+By default, the docs are output to `smashing_docs/api_docs.md` in the Rails project.
+You can change this by altering the config in `test_helper.rb` (MiniTest) or
+`rails_helper.rb`(RSpec).
 
 ## Additional Features
 
@@ -179,7 +180,7 @@ SmashingDocs can automatically push your generated docs to your project wiki.
 
     ../projects/my_rails_app.wiki
 
-  2. Set auto_push to true in `spec_helper.rb` or `test_helper.rb`
+  2. Set auto_push to true in `rails_helper.rb` or `test_helper.rb`
 
     ``` ruby
       SmashingDocs.config do |c|
@@ -189,3 +190,9 @@ SmashingDocs can automatically push your generated docs to your project wiki.
     ```
 
   3. Build your docs with `rails g smashing_documentation:build_docs`
+
+#### Generate Docs on Every Test Suite Run
+
+If you prefer to have your docs built every time you run the test suite, and do
+not want to run the build command, then uncomment the `SmashingDocs.finish` line
+in your `rails_helper` or `test_helper`

data/lib/generators/smashing_documentation/install_generator.rb

@@ -73,6 +73,7 @@ module SmashingDocumentation
         config = "SmashingDocs.config do |c|\n"\
                  "  c.template_file = 'smashing_docs/template.md'\n"\
                  "  c.output_file   = 'smashing_docs/api_docs.md'\n"\
+                 "  c.run_all       = true\n"\
                  "  c.auto_push     = false\n"\
                  "end\n"
         if using_minitest?

data/smashing_docs.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.summary = "Uses your test cases to write example documentation for your API."
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.version = '1.2.0'
+  s.version = '1.2.1'
 
   s.add_development_dependency "bundler", "~> 1.11"
   s.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smashing_docs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Tyler Rockwell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler