https://github.com/rubyworks/yard-qed
QED plugin for YARD
https://github.com/rubyworks/yard-qed
Last synced: 8 months ago
JSON representation
QED plugin for YARD
- Host: GitHub
- URL: https://github.com/rubyworks/yard-qed
- Owner: rubyworks
- License: other
- Created: 2011-11-19T05:59:44.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2012-12-09T04:20:37.000Z (about 13 years ago)
- Last Synced: 2025-05-02T11:44:39.902Z (10 months ago)
- Language: Ruby
- Homepage: http://rubyworks.github.com/yard-qed
- Size: 375 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# YARD QED
[Website](http://github.com/rubyworks/yard-qed) |
[Source Code](http://github.com/rubyworls/yard-qed) |
[Mailing List](http://groups.google.com/group/rubyworks-mailinglist) |
[IRC](#rubyworks)
## Description
Automatically add QED docs to YARD docs without need to create
any intermediary files.
## Usage
As with most YARD plugins.
$ yardoc --plugin qed
This will look for one of the default `qed`, `demo` or `spec` directories,
and use the files located there.
## Limitations
* It is assume all your QED docs are in one format. Mixing and matching
between RDoc and Markdown might cause some rendering issues.
* There is currently no way to set
the location or file globs to anything else --patches welcome.
## Copying
Copyright (c) 2011 Rubyworks. All rights reserved.
YARD QED is distributable in accordance with the terms of
the *BSD-2-Clause* license.
See LICENSE.txt for details.