CONTRIBUTING.adoc in asciidoctor-1.5.6.1 vs CONTRIBUTING.adoc in asciidoctor-1.5.6.2

- old
+ new

@@ -11,14 +11,16 @@ :uri-issues: {uri-repo}/issues :uri-fork-help: {uri-help-base}/fork-a-repo :uri-branch-help: {uri-fork-help}#create-branches :uri-pr-help: {uri-help-base}/using-pull-requests :uri-gist: https://gist.github.com +:uri-yard: https://yardoc.org +:uri-tomdoc: http://tomdoc.org == License Agreement -By contributing changes to this repository, you agree to license your contributions under the <<LICENSE#,MIT license>>. +By contributing changes to this repository, you agree to license your contributions under the MIT license. This ensures your contributions have the same license as the project and that the community is free to use your contributions. You also assert that you are the original author of the work that you are contributing unless otherwise stated. == Submitting an Issue @@ -160,9 +162,21 @@ alias asciidoctor-dev="/path/to/asciidoctor/bin/asciidoctor" Now you can execute the `asciidoctor` command from any folder as follows: $ asciidoctor-dev README.adoc + +== Building the API Documentation + +The API documentation is written in the {uri-tomdoc}[TomDoc] dialect and built using {uri-yard}[Yard]. + +The options for Yard are configured in the [.path]_.yardopts_ file at the root of the project. + +To build the API documentation locally, run the following command: + + $ bundle exec yard + +The documentation will be built into the [.path]_rdoc_ folder. == Supporting Additional Ruby Versions If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation.