Skip to content

Commit 6e17a81

Browse files
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent db2abf7 commit 6e17a81

File tree

4 files changed

+35
-2
lines changed

4 files changed

+35
-2
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
ruby:
2323
- 2.6
2424
- 2.7
25-
- 3.0
25+
- "3.0"
2626
- 3.1
2727
- ruby-head
2828
- jruby

.github/workflows/generate-docs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Build & deploy documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
workflow_dispatch:
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
name: Update gh-pages with docs
11+
steps:
12+
- name: Clone repository
13+
uses: actions/checkout@v2
14+
- name: Set up Ruby
15+
uses: ruby/setup-ruby@v1
16+
with:
17+
ruby-version: "3.1"
18+
- name: Install required gem dependencies
19+
run: gem install yard --no-document
20+
- name: Build YARD Ruby Documentation
21+
run: yardoc
22+
- name: Deploy
23+
uses: peaceiris/actions-gh-pages@v3
24+
with:
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
publish_dir: ./doc/yard
27+
publish_branch: gh-pages

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ puts data.to_json_c14n
6060
```
6161

6262
## Documentation
63-
Full documentation available on [RubyDoc](http://rubydoc.info/gems/json-canonicalization/file/README.md)
63+
Full documentation available on [RubyDoc](https://dryruby.github.io/json-canonicalization/file/README.md)
6464

6565
### Principal Classes
6666
* {JSON::Canonicalization}

json-canonicalization.gemspec

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Gem::Specification.new do |gem|
1010
gem.license = 'Unlicense'
1111
gem.summary = "JSON Canonicalization for Ruby."
1212
gem.description = "JSON::Canonicalization generates canonical JSON output from Ruby objects."
13+
gem.metadata = {
14+
"documentation_uri" => "https://dryruby.github.io/json-canonicalization",
15+
"bug_tracker_uri" => "https://github.com/dryruby/json-canonicalization/issues",
16+
"homepage_uri" => "https://github.com/dryruby/json-canonicalization",
17+
"source_code_uri" => "https://github.com/dryruby/json-canonicalization",
18+
}
1319

1420
gem.authors = ['Gregg Kellogg']
1521

0 commit comments

Comments
 (0)