Skip to content

Commit

Permalink
Bump to 0.8.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
lsegal committed Apr 15, 2013
1 parent 37249ea commit 8b5f4c2
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 5 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
**Contributors**: See Contributors section below
**Copyright**: 2007-2013
**License**: MIT License
**Latest Version**: 0.8.6
**Release Date**: April 13th 2013
**Latest Version**: 0.8.6.1
**Release Date**: April 14th 2013

## Synopsis

Expand Down Expand Up @@ -283,6 +283,11 @@ More options can be seen by typing `yard graph --help`, but here is an example:

## Changelog

- **April.14.13**: 0.8.6.1 release
- Fixed broken links in File menu on default HTML template
- Added --layout switch to `yard display` to wrap output in layout template.
- See {file:docs/WhatsNew.md} for more information on added features.

- **April.13.13**: 0.8.6 release
- Various fixes and improved Ruby 2.x compatibility support
- Added support for `asciidoc` markup type
Expand Down
25 changes: 23 additions & 2 deletions docs/WhatsNew.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
16. **Added `-B/--bind` to bind to a port in yard server** (0.8.4)
17. **Added `asciidoc` markup type support** (0.8.6)
18. **Added `yard markups` command to list available markup types** (0.8.6)
18. **Added `yard display` command to display formatted objects** (0.8.6)
19. **Added `yard display` command to display formatted objects** (0.8.6)
20. **Added `--layout` to `yard display` command** (0.8.6.1)

## Directives (new behavioural tag syntax) (0.8.0)

Expand Down Expand Up @@ -319,7 +320,8 @@ provider library, pass the `-M PROVIDER_NAME` option.
## Added `yard display` command to display formatted objects (0.8.6)

<p class="note">This feature requires the .yardoc registry to have already been
generated. To generate the registry, run <code>yard doc -n</code>.</p>
generated. To generate the registry, run <code>yard doc -n</code>.
</p>

You can now display a single object (or a list of objects) in the YARD registry
using the `yard display OBJECT ...` command. For example, to display the
Expand All @@ -336,6 +338,25 @@ web browser:
Custom templating options from `yard doc` can also be used, see
`yard display --help` for more options.

## Added `--layout` to `yard display` command (0.8.6.1)

The `yard display` command now accepts `--layout` to wrap content in a layout
template. Currently the `layout` and `onefile` layout templates are supported,
though any template can be used. If no parameter is specified, the layout will
default to the `layout` template. Example usage:

$ yard display --layout onefile -f html YARD::CodeObjects > codeobjects.html

The above generates a `codeobjects.html` file that is self-contained with
CSS stylesheets and JavaScript code. This is similar to calling
`yard doc --one-file` with only the YARD::CodeObjects object in the registry.

Note that even though this uses the onefile template, the README file will not
be auto-included the way it is with the `yard doc` command. To include the
README text at the top of the onefile template, pass the --readme switch:

$ yard display --layout onefile -f html --readme README.md OBJECT > out.html

# What's New in 0.7.x?

1. **Macro support and detection of DSL methods** (0.7.0)
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module YARD
VERSION = "0.8.6"
VERSION = "0.8.6.1"
end

0 comments on commit 8b5f4c2

Please sign in to comment.