Skip to content

Commit 12ec83a

Browse files
gkellogggkellogg
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent c5cd1b4 commit 12ec83a

File tree

9 files changed

+72
-38
lines changed

9 files changed

+72
-38
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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Example usage:
190190

191191
## Documentation
192192

193-
<https://rubydoc.info/github/ruby-rdf/shex>
193+
<https://ruby-rdf.github.io/shex>
194194

195195

196196
## Implementation Notes
@@ -224,7 +224,7 @@ follows:
224224

225225
## Resources
226226

227-
* <https://rubydoc.info/github/ruby-rdf/shex>
227+
* <https://ruby-rdf.github.io/shex>
228228
* <https://github.com/ruby-rdf/shex>
229229
* <https://rubygems.org/gems/shex>
230230

@@ -264,7 +264,7 @@ see <https://unlicense.org/> or the accompanying {file:LICENSE} file.
264264

265265
[ShExSpec]: http://shex.io/shex-semantics-20170713/
266266
[RDF]: https://www.w3.org/RDF/
267-
[RDF.rb]: https://rubydoc.info/github/ruby-rdf/rdf
267+
[RDF.rb]: https://ruby-rdf.github.io/rdf
268268
[EBNF]: https://rubygems.org/gems/ebnf
269269
[YARD]: https://yardoc.org/
270270
[YARD-GS]: https://rubydoc.info/docs/yard/file/docs/GettingStarted.md

‎etc/doap.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/shex> a doap:Project, earl:TestSubject, earl:Software ;
1212
doap:name "ShEx" ;
13-
doap:homepage <https://ruby-rdf.github.com/shex> ;
13+
doap:homepage <https://ruby-rdf.github.io/shex> ;
1414
doap:license <https://unlicense.org/1.0/> ;
1515
doap:shortdesc "ShEx is a Shape Expression engine for Ruby RDF.rb."@en ;
1616
doap:description "ShEx is an Shape Expression engine for the Ruby RDF.rb library suite."@en ;

‎etc/earl.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ <h2>
8181
<dd property='doap:programming-language'>Ruby</dd>
8282
<dt>Home Page</dt>
8383
<dd property='doap:homepage'>
84-
<a href='http://ruby-rdf.github.com/shex'>
85-
http://ruby-rdf.github.com/shex
84+
<a href='https://ruby-rdf.github.io/shex'>
85+
https://ruby-rdf.github.io/shex
8686
</a>
8787
</dd>
8888
<dt>Developer</dt>

‎etc/earl.jsonld‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -40093,7 +40093,7 @@
4009340093
}
4009440094
],
4009540095
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40096-
"homepage": "http://ruby-rdf.github.com/shex",
40096+
"homepage": "https://ruby-rdf.github.io/shex",
4009740097
"language": "Ruby",
4009840098
"name": "ShEx.rb"
4009940099
},
@@ -40169,7 +40169,7 @@
4016940169
}
4017040170
],
4017140171
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40172-
"homepage": "http://ruby-rdf.github.com/shex",
40172+
"homepage": "https://ruby-rdf.github.io/shex",
4017340173
"language": "Ruby",
4017440174
"name": "ShEx.rb"
4017540175
},
@@ -40502,7 +40502,7 @@
4050240502
}
4050340503
],
4050440504
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40505-
"homepage": "http://ruby-rdf.github.com/shex",
40505+
"homepage": "https://ruby-rdf.github.io/shex",
4050640506
"language": "Ruby",
4050740507
"name": "ShEx.rb"
4050840508
},
@@ -40578,7 +40578,7 @@
4057840578
}
4057940579
],
4058040580
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40581-
"homepage": "http://ruby-rdf.github.com/shex",
40581+
"homepage": "https://ruby-rdf.github.io/shex",
4058240582
"language": "Ruby",
4058340583
"name": "ShEx.rb"
4058440584
},
@@ -40818,7 +40818,7 @@
4081840818
}
4081940819
],
4082040820
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40821-
"homepage": "http://ruby-rdf.github.com/shex",
40821+
"homepage": "https://ruby-rdf.github.io/shex",
4082240822
"language": "Ruby",
4082340823
"name": "ShEx.rb"
4082440824
},
@@ -40894,7 +40894,7 @@
4089440894
}
4089540895
],
4089640896
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
40897-
"homepage": "http://ruby-rdf.github.com/shex",
40897+
"homepage": "https://ruby-rdf.github.io/shex",
4089840898
"language": "Ruby",
4089940899
"name": "ShEx.rb"
4090040900
},
@@ -49383,7 +49383,7 @@
4938349383
}
4938449384
],
4938549385
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
49386-
"homepage": "http://ruby-rdf.github.com/shex",
49386+
"homepage": "https://ruby-rdf.github.io/shex",
4938749387
"language": "Ruby",
4938849388
"name": "ShEx.rb"
4938949389
},
@@ -49521,7 +49521,7 @@
4952149521
}
4952249522
],
4952349523
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
49524-
"homepage": "http://ruby-rdf.github.com/shex",
49524+
"homepage": "https://ruby-rdf.github.io/shex",
4952549525
"language": "Ruby",
4952649526
"name": "ShEx.rb"
4952749527
},
@@ -55923,7 +55923,7 @@
5592355923
}
5592455924
],
5592555925
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
55926-
"homepage": "http://ruby-rdf.github.com/shex",
55926+
"homepage": "https://ruby-rdf.github.io/shex",
5592755927
"language": "Ruby",
5592855928
"name": "ShEx.rb"
5592955929
},
@@ -56028,7 +56028,7 @@
5602856028
}
5602956029
],
5603056030
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56031-
"homepage": "http://ruby-rdf.github.com/shex",
56031+
"homepage": "https://ruby-rdf.github.io/shex",
5603256032
"language": "Ruby",
5603356033
"name": "ShEx.rb"
5603456034
},
@@ -56089,7 +56089,7 @@
5608956089
}
5609056090
],
5609156091
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56092-
"homepage": "http://ruby-rdf.github.com/shex",
56092+
"homepage": "https://ruby-rdf.github.io/shex",
5609356093
"language": "Ruby",
5609456094
"name": "ShEx.rb"
5609556095
},
@@ -56199,7 +56199,7 @@
5619956199
}
5620056200
],
5620156201
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56202-
"homepage": "http://ruby-rdf.github.com/shex",
56202+
"homepage": "https://ruby-rdf.github.io/shex",
5620356203
"language": "Ruby",
5620456204
"name": "ShEx.rb"
5620556205
},
@@ -56260,7 +56260,7 @@
5626056260
}
5626156261
],
5626256262
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56263-
"homepage": "http://ruby-rdf.github.com/shex",
56263+
"homepage": "https://ruby-rdf.github.io/shex",
5626456264
"language": "Ruby",
5626556265
"name": "ShEx.rb"
5626656266
},
@@ -56406,7 +56406,7 @@
5640656406
}
5640756407
],
5640856408
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56409-
"homepage": "http://ruby-rdf.github.com/shex",
56409+
"homepage": "https://ruby-rdf.github.io/shex",
5641056410
"language": "Ruby",
5641156411
"name": "ShEx.rb"
5641256412
},
@@ -56580,7 +56580,7 @@
5658056580
}
5658156581
],
5658256582
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56583-
"homepage": "http://ruby-rdf.github.com/shex",
56583+
"homepage": "https://ruby-rdf.github.io/shex",
5658456584
"language": "Ruby",
5658556585
"name": "ShEx.rb"
5658656586
},
@@ -56682,7 +56682,7 @@
5668256682
}
5668356683
],
5668456684
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56685-
"homepage": "http://ruby-rdf.github.com/shex",
56685+
"homepage": "https://ruby-rdf.github.io/shex",
5668656686
"language": "Ruby",
5668756687
"name": "ShEx.rb"
5668856688
},
@@ -56820,7 +56820,7 @@
5682056820
}
5682156821
],
5682256822
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56823-
"homepage": "http://ruby-rdf.github.com/shex",
56823+
"homepage": "https://ruby-rdf.github.io/shex",
5682456824
"language": "Ruby",
5682556825
"name": "ShEx.rb"
5682656826
},
@@ -56922,7 +56922,7 @@
5692256922
}
5692356923
],
5692456924
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
56925-
"homepage": "http://ruby-rdf.github.com/shex",
56925+
"homepage": "https://ruby-rdf.github.io/shex",
5692656926
"language": "Ruby",
5692756927
"name": "ShEx.rb"
5692856928
},
@@ -57024,7 +57024,7 @@
5702457024
}
5702557025
],
5702657026
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
57027-
"homepage": "http://ruby-rdf.github.com/shex",
57027+
"homepage": "https://ruby-rdf.github.io/shex",
5702857028
"language": "Ruby",
5702957029
"name": "ShEx.rb"
5703057030
},
@@ -57126,7 +57126,7 @@
5712657126
}
5712757127
],
5712857128
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
57129-
"homepage": "http://ruby-rdf.github.com/shex",
57129+
"homepage": "https://ruby-rdf.github.io/shex",
5713057130
"language": "Ruby",
5713157131
"name": "ShEx.rb"
5713257132
},
@@ -57228,7 +57228,7 @@
5722857228
}
5722957229
],
5723057230
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
57231-
"homepage": "http://ruby-rdf.github.com/shex",
57231+
"homepage": "https://ruby-rdf.github.io/shex",
5723257232
"language": "Ruby",
5723357233
"name": "ShEx.rb"
5723457234
},
@@ -57366,7 +57366,7 @@
5736657366
}
5736757367
],
5736857368
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
57369-
"homepage": "http://ruby-rdf.github.com/shex",
57369+
"homepage": "https://ruby-rdf.github.io/shex",
5737057370
"language": "Ruby",
5737157371
"name": "ShEx.rb"
5737257372
},
@@ -60708,7 +60708,7 @@
6070860708
}
6070960709
],
6071060710
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
60711-
"homepage": "http://ruby-rdf.github.com/shex",
60711+
"homepage": "https://ruby-rdf.github.io/shex",
6071260712
"language": "Ruby",
6071360713
"name": "ShEx.rb"
6071460714
},
@@ -60813,7 +60813,7 @@
6081360813
}
6081460814
],
6081560815
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
60816-
"homepage": "http://ruby-rdf.github.com/shex",
60816+
"homepage": "https://ruby-rdf.github.io/shex",
6081760817
"language": "Ruby",
6081860818
"name": "ShEx.rb"
6081960819
},
@@ -60915,7 +60915,7 @@
6091560915
}
6091660916
],
6091760917
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
60918-
"homepage": "http://ruby-rdf.github.com/shex",
60918+
"homepage": "https://ruby-rdf.github.io/shex",
6091960919
"language": "Ruby",
6092060920
"name": "ShEx.rb"
6092160921
},
@@ -61017,7 +61017,7 @@
6101761017
}
6101861018
],
6101961019
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
61020-
"homepage": "http://ruby-rdf.github.com/shex",
61020+
"homepage": "https://ruby-rdf.github.io/shex",
6102161021
"language": "Ruby",
6102261022
"name": "ShEx.rb"
6102361023
},
@@ -61119,7 +61119,7 @@
6111961119
}
6112061120
],
6112161121
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
61122-
"homepage": "http://ruby-rdf.github.com/shex",
61122+
"homepage": "https://ruby-rdf.github.io/shex",
6112361123
"language": "Ruby",
6112461124
"name": "ShEx.rb"
6112561125
},
@@ -65049,7 +65049,7 @@
6504965049
}
6505065050
],
6505165051
"doapDesc": "ShEx is an Shape Expression engine for the RDF.rb library suite.",
65052-
"homepage": "http://ruby-rdf.github.com/shex",
65052+
"homepage": "https://ruby-rdf.github.io/shex",
6505365053
"language": "Ruby",
6505465054
"name": "ShEx.rb"
6505565055
}

‎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/shex> a doap:Project, earl:TestSubject, earl:Software ;
1212
doap:name "ShEx.rb" ;
13-
doap:homepage <http://ruby-rdf.github.com/shex> ;
13+
doap:homepage <https://ruby-rdf.github.io/shex> ;
1414
doap:license <https://unlicense.org/1.0/> ;
1515
doap:shortdesc "ShEx is a Shape Expression engine for Ruby."@en ;
1616
doap:description "ShEx is an Shape Expression engine for the RDF.rb library suite."@en ;

‎lib/shex/parser.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class Parser
3030
# The internal representation of the result using hierarchy of RDF objects and ShEx::Operator
3131
# objects.
3232
# @return [Array]
33-
# @see https://www.rubydoc.info/github/ruby-rdf/sparql/SPARQL/Algebra
33+
# @see https://ruby-rdf.github.io/sparql/SPARQL/Algebra
3434
attr_accessor :result
3535

3636
# Terminals passed to lexer. Order matters!

‎shex.gemspec‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,17 @@ Gem::Specification.new do |gem|
66
gem.date = File.mtime('VERSION').strftime('%Y-%m-%d')
77

88
gem.name = 'shex'
9-
gem.homepage = 'https://ruby-rdf.github.com/shex'
9+
gem.homepage = 'https://github.com/ruby-rdf/shex'
1010
gem.license = 'Unlicense'
1111
gem.summary = 'Implementation of Shape Expressions (ShEx) for RDF.rb'
1212
gem.description = 'Implements ShExC and ShEx JSON.'
13+
gem.metadata = {
14+
"documentation_uri" => "https://ruby-rdf.github.io/shex",
15+
"bug_tracker_uri" => "https://github.com/ruby-rdf/shex/issues",
16+
"homepage_uri" => "https://github.com/ruby-rdf/shex",
17+
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
18+
"source_code_uri" => "https://github.com/ruby-rdf/shex",
19+
}
1320

1421
gem.authors = ['Gregg Kellogg']
1522
gem.email = '[email protected]'

0 commit comments

Comments
 (0)