Skip to content

Commit 69ee66b

Browse files
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent 178e6b6 commit 69ee66b

8 files changed

Lines changed: 494 additions & 460 deletions

File tree

.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
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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,6 @@ A copy of the [LD Patch EBNF](file:etc/ld-patch.ebnf) and derived parser files a
118118
[SPARQL]: https://rubygems.org/gems/sparql
119119
[Linked Data]: https://rubygems.org/gems/linkeddata
120120
[SSE]: http://openjena.org/wiki/SSE
121-
[SXP]: https://rubygems.org/gems/sxp-ruby
121+
[SXP]: https://dryruby.github.io/sxp
122122
[LD Patch]: http://www.w3.org/TR/ldpatch/
123-
[LD-Patch doc]: http://rubydoc.info/github/ruby-rdf/ld-patch
123+
[LD-Patch doc]: https://ruby-rdf.github.io/ld-patch

etc/doap.ttl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<> a doap:Project, earl:TestSubject, earl:Software ;
1313
doap:name "LD::Patch" ;
14-
doap:homepage <https://ruby-rdf.github.com/ld-patch> ;
14+
doap:homepage <https://ruby-rdf.github.io/ld-patch> ;
1515
doap:license <https://unlicense.org/1.0/> ;
1616
doap:shortdesc "W3C Linked Data Patch Format for RDF.rb."@en ;
1717
doap:description "Implements the W3C Linked Data Patch Format and operations for RDF.rb."@en ;

etc/earl.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ <h2>
8888
<dd property='doap:programming-language'>Ruby</dd>
8989
<dt>Home Page</dt>
9090
<dd property='doap:homepage'>
91-
<a href='http://ruby-rdf.github.com/ld-patch'>
92-
http://ruby-rdf.github.com/ld-patch
91+
<a href='https://ruby-rdf.github.io/ld-patch'>
92+
https://ruby-rdf.github.io/ld-patch
9393
</a>
9494
</dd>
9595
<dt>Developer</dt>

etc/earl.jsonld

Lines changed: 453 additions & 453 deletions
Large diffs are not rendered by default.

etc/earl.ttl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<https://rubygems.org/gems/ld-patch> a doap:Project, earl:TestSubject, earl:Software ;
1212
doap:name "LD::Patch" ;
13-
doap:homepage <http://ruby-rdf.github.com/ld-patch> ;
13+
doap:homepage <https://ruby-rdf.github.io/ld-patch> ;
1414
doap:license <https://unlicense.org/1.0/> ;
1515
doap:shortdesc "W3C Linked Data Patch Format for RDF.rb."@en ;
1616
doap:description """

ld-patch.gemspec

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ Gem::Specification.new do |gem|
99
gem.homepage = "https://github.com/ruby-rdf/ld-patch"
1010
gem.license = 'Unlicense'
1111
gem.summary = "W3C Linked Data Patch Format for RDF.rb."
12+
gem.metadata = {
13+
"documentation_uri" => "https://ruby-rdf.github.io/ld-patch",
14+
"bug_tracker_uri" => "https://github.com/ruby-rdf/ld-patch/issues",
15+
"homepage_uri" => "https://github.com/ruby-rdf/ld-patch",
16+
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
17+
"source_code_uri" => "https://github.com/ruby-rdf/ld-patch",
18+
}
1219

1320
gem.authors = ['Gregg Kellogg']
1421
gem.email = 'public-rdf-ruby@w3.org'

0 commit comments

Comments
 (0)