yard-lucid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08c7f6d439f619b3b01a3d229184f5b8db4cc8bc
-  data.tar.gz: 467656c8cdc9fd50cbd6634e3fd5d59728ef8d20
+  metadata.gz: d1373a484e51aba3b4420ebb1b736346af41f1c3
+  data.tar.gz: 390dde9be9c53f05fea2641d48399795a9a1a307
 SHA512:
-  metadata.gz: fd30a4ebd5c804ecb919757c2e51a55b60fa0dcd794eb11ec3cde282d8b0c61ecb57667682e89b59869d9ff528b29d69117baa2630782dd2d72dbc9c96704bb6
-  data.tar.gz: a72c6c29ba127364f97349e9f1300c7ed6821de1375ce9b1a2af7118717cf8f7b0f0aaa92f5abc74c469ee5f5130b7e00bdcf435de56b6c0ef8f8d557906b3ab
+  metadata.gz: 108e8a84b704bf5ab72da01cd0f57ac8c93e7dfec008f60a40eacb49995154d4e165bda378e1c52f10e72b1d43a513dc10691271bf93db21fdf919de7da4baa7
+  data.tar.gz: d03f0c585b9e8dac3b587fb78458bc43453ea7a8e91c62dfa9598fcaba4e110ea3e6595bc7db9a5d8799fcb2042d587cdd3645411e74e57223a13f2fe44778b5

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-lucid

data/README.md

@@ -53,6 +53,54 @@ Once that is done, you can run YARD as you normally would and have your Gherkin
 $ yardoc 'features/**/*.feature' 'steps/**/*.rb'
 ```
 
+### Documentation Server
+
+You can also use the YARD server to serve up a copy of a documentation repository. In the directory where you generated your documentation, do this:
+
+```
+yard server
+```
+
+This will start up a server at http://localhost:8808 that you can then view your repository at.
+
+### Configuration
+
+By default the yardoc output will generate a search field for features and tags. This can be configured through the yard configuration file `~/.yard/config`. By default the configuration, YAML format, that is generate by the `yard config` command will save a `SymbolHash`. You can still edit this file add the entry for `:"yard-lucid":` and the sub-entry `menus:`. Here's an example:
+
+```yaml
+--- !map:SymbolHash
+:load_plugins: true
+:ignored_plugins: []
+
+:autoload_plugins: []
+
+:safe_mode: false
+
+:"yard-lucid":
+  menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
+```
+
+This allows you to add or remove these search fields. The `menus` section can contain all of the above mentioned menus or simply an empty array `[]` if you want no additional menus.
+
+You can exclude any feature or scenario from the yardoc by adding predefined tags to them. To define tags that will be excluded in the yard configuration file, just do this:
+
+```yaml
+  :"yard-lucid":
+    exclude_tags: [ 'practice', 'demo' ]
+```
+
+Here any scenarios or features marked with the tags `@practice` or `@demo` would not be included in the documentation.
+
+Finally, you may want to add other step definition keywords. Lucid Yard already supports the English step definition keywords, but you might want to add foreign language ones. Or you might be using some variant of Gherkin that allows for different step definitions. Using the yard configuration file, you can define additional step definitions that can be matched.
+
+```yaml
+:"yard-lucid":
+  language:
+    step_definitions: [ 'Given', 'When', 'Then', 'And', '*', 'Soit', 'Etantdonné', 'Lorsque', 'Lorsqu', 'Alors', 'Et' ]
+```
+
+Note that when doing this you'll want to include the defaults that Lucid Yard provides as well.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Given the nature of Lucid Yard, it's difficult to provide unit tests for it, so you won't find a great deal of them. In fact, you'll find basically none.

data/lib/yard-lucid/version.rb

@@ -1,3 +1,3 @@
 module YardLucid
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-lucid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -191,7 +192,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ Yard-Lucid 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ Yard-Lucid 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths: