Skip to content

Commit 8d79f79

Browse files
gkellogggkellogg
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent 7bf8fa3 commit 8d79f79

6 files changed

Lines changed: 76 additions & 49 deletions

File tree

‎.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: Checkout this repo
13+
uses: actions/checkout@v2
14+
- name: Set up Ruby
15+
uses: actions/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: $
26+
publish_dir: ./doc/yard
27+
publish_branch: gh-pages

‎README.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This is a pure-Ruby library for working with [Resource Description Framework
44
(RDF)][RDF] data.
55

6-
* <https://ruby-rdf.github.com/rdf>
6+
* <https://ruby-rdf.github.io/rdf>
77

88
[![Gem Version](https://badge.fury.io/rb/rdf.png)](https://badge.fury.io/rb/rdf)
99
[![Build Status](https://github.com/ruby-rdf/rdf/workflows/CI/badge.svg?branch=develop)](https://github.com/ruby-rdf/rdf/actions?query=workflow%3ACI)
@@ -141,11 +141,11 @@ or
141141
### Reading RDF data in the [N-Triples][] format
142142

143143
require 'rdf/ntriples'
144-
graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nt")
144+
graph = RDF::Graph.load("https://ruby-rdf.github.io/rdf/etc/doap.nt")
145145

146146
or
147147

148-
RDF::Reader.open("https://ruby-rdf.github.com/rdf/etc/doap.nt") do |reader|
148+
RDF::Reader.open("https://ruby-rdf.github.io/rdf/etc/doap.nt") do |reader|
149149
reader.each_statement do |statement|
150150
puts statement.inspect
151151
end
@@ -160,13 +160,13 @@ MimeType or file extension, where available.
160160

161161
require 'rdf/nquads'
162162

163-
graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nq", format: :nquads)
163+
graph = RDF::Graph.load("https://ruby-rdf.github.io/rdf/etc/doap.nq", format: :nquads)
164164

165165
A specific sub-type of Reader can also be invoked directly:
166166

167167
require 'rdf/nquads'
168168

169-
RDF::NQuads::Reader.open("https://ruby-rdf.github.com/rdf/etc/doap.nq") do |reader|
169+
RDF::NQuads::Reader.open("https://ruby-rdf.github.io/rdf/etc/doap.nq") do |reader|
170170
reader.each_statement do |statement|
171171
puts statement.inspect
172172
end
@@ -220,7 +220,7 @@ Note that no prefixes are loaded automatically, however they can be provided as
220220

221221
require 'rdf/ntriples'
222222

223-
graph = RDF::Graph.load("https://ruby-rdf.github.com/rdf/etc/doap.nt")
223+
graph = RDF::Graph.load("https://ruby-rdf.github.io/rdf/etc/doap.nt")
224224
query = RDF::Query.new({
225225
person: {
226226
RDF.type => FOAF.Person,
@@ -295,7 +295,7 @@ Readers support a boolean valued `rdfstar` option.
295295

296296
## Documentation
297297

298-
<https://rubydoc.info/github/ruby-rdf/rdf>
298+
<https://ruby-rdf.github.io/rdf>
299299

300300
### RDF Object Model
301301

@@ -309,7 +309,7 @@ Readers support a boolean valued `rdfstar` option.
309309
* {RDF::Literal::Double}
310310
* {RDF::Literal::Integer}
311311
* {RDF::Literal::Time}
312-
* [RDF::XSD](https://rubydoc.info/github/gkellogg/rdf-xsd) (extension)
312+
* [RDF::XSD](https://ruby-rdf.github.io/rdf-xsd) (extension)
313313
* {RDF::Resource}
314314
* {RDF::Node}
315315
* {RDF::URI}
@@ -371,10 +371,10 @@ from BNode identity (i.e., they each entail the other)
371371
* {RDF::Mutable}
372372
* {RDF::Durable}
373373
* {RDF::Transaction}
374-
* [RDF::AllegroGraph](https://rubydoc.info/github/ruby-rdf/rdf-agraph) (extension)
375-
* [RDF::Mongo](https://rubydoc.info/github/ruby-rdf/rdf-mongo) (extension)
376-
* [RDF::DataObjects](https://rubydoc.info/github/ruby-rdf/rdf-do) (extension)
377-
* [RDF::Sesame](https://rubydoc.info/github/ruby-rdf/rdf-sesame) (extension)
374+
* [RDF::AllegroGraph](https://ruby-rdf.github.io/rdf-agraph) (extension)
375+
* [RDF::Mongo](https://ruby-rdf.github.io/rdf-mongo) (extension)
376+
* [RDF::DataObjects](https://ruby-rdf.github.io/rdf-do) (extension)
377+
* [RDF::Sesame](https://ruby-rdf.github.io/rdf-sesame) (extension)
378378

379379
### RDF Querying
380380

@@ -384,7 +384,7 @@ from BNode identity (i.e., they each entail the other)
384384
* {RDF::Query::Solution}
385385
* {RDF::Query::Solutions}
386386
* {RDF::Query::Variable}
387-
* [SPARQL](https://rubydoc.info/github/ruby-rdf/sparql) (extension)
387+
* [SPARQL](https://ruby-rdf.github.io/sparql) (extension)
388388

389389

390390
### RDF Vocabularies
@@ -422,7 +422,7 @@ follows:
422422

423423
## Resources
424424

425-
* <https://rubydoc.info/github/ruby-rdf/rdf>
425+
* <https://ruby-rdf.github.io/rdf>
426426
* <https://github.com/ruby-rdf/rdf>
427427
* <https://rubygems.org/gems/rdf>
428428
* <https://www.ohloh.net/p/rdf>
@@ -486,33 +486,33 @@ see <https://unlicense.org/> or the accompanying {file:UNLICENSE} file.
486486
[YARD]: https://yardoc.org/
487487
[YARD-GS]: https://rubydoc.info/docs/yard/file/docs/GettingStarted.md
488488
[PDD]: https://unlicense.org/#unlicensing-contributions
489-
[JSONLD doc]: https://rubydoc.info/github/ruby-rdf/json-ld
490-
[LinkedData doc]: https://rubydoc.info/github/ruby-rdf/linkeddata
491-
[Microdata doc]: https://rubydoc.info/github/ruby-rdf/rdf-microdata
492-
[N3 doc]: https://rubydoc.info/github/ruby-rdf/rdf-n3
493-
[RDFa doc]: https://rubydoc.info/github/ruby-rdf/rdf-rdfa
494-
[RDFXML doc]: https://rubydoc.info/github/ruby-rdf/rdf-rdfxml
495-
[Turtle doc]: https://rubydoc.info/github/ruby-rdf/rdf-turtle
496-
[SPARQL doc]: https://rubydoc.info/github/ruby-rdf/sparql
489+
[JSONLD doc]: https://ruby-rdf.github.io/json-ld
490+
[LinkedData doc]: https://ruby-rdf.github.io/linkeddata
491+
[Microdata doc]: https://ruby-rdf.github.io/rdf-microdata
492+
[N3 doc]: https://ruby-rdf.github.io/rdf-n3
493+
[RDFa doc]: https://ruby-rdf.github.io/rdf-rdfa
494+
[RDFXML doc]: https://ruby-rdf.github.io/rdf-rdfxml
495+
[Turtle doc]: https://ruby-rdf.github.io/rdf-turtle
496+
[SPARQL doc]: https://ruby-rdf.github.io/sparql
497497
[RDF 1.0]: https://www.w3.org/TR/2004/REC-rdf-concepts-20040210/
498498
[RDF 1.1]: https://www.w3.org/TR/rdf11-concepts/
499499
[SPARQL 1.1]: https://www.w3.org/TR/sparql11-query/
500-
[RDF.rb]: https://ruby-rdf.github.com/
501-
[RDF::DO]: https://ruby-rdf.github.com/rdf-do
502-
[RDF::Mongo]: https://ruby-rdf.github.com/rdf-mongo
503-
[RDF::Sesame]: https://ruby-rdf.github.com/rdf-sesame
504-
[RDF::JSON]: https://ruby-rdf.github.com/rdf-json
505-
[RDF::Microdata]: https://ruby-rdf.github.com/rdf-microdata
506-
[RDF::N3]: https://ruby-rdf.github.com/rdf-n3
507-
[RDF::RDFa]: https://ruby-rdf.github.com/rdf-rdfa
508-
[RDF::RDFXML]: https://ruby-rdf.github.com/rdf-rdfxml
509-
[RDF::TriG]: https://ruby-rdf.github.com/rdf-trig
510-
[RDF::TriX]: https://ruby-rdf.github.com/rdf-trix
511-
[RDF::Turtle]: https://ruby-rdf.github.com/rdf-turtle
512-
[RDF::Raptor]: https://ruby-rdf.github.com/rdf-raptor
500+
[RDF.rb]: https://ruby-rdf.github.io/
501+
[RDF::DO]: https://ruby-rdf.github.io/rdf-do
502+
[RDF::Mongo]: https://ruby-rdf.github.io/rdf-mongo
503+
[RDF::Sesame]: https://ruby-rdf.github.io/rdf-sesame
504+
[RDF::JSON]: https://ruby-rdf.github.io/rdf-json
505+
[RDF::Microdata]: https://ruby-rdf.github.io/rdf-microdata
506+
[RDF::N3]: https://ruby-rdf.github.io/rdf-n3
507+
[RDF::RDFa]: https://ruby-rdf.github.io/rdf-rdfa
508+
[RDF::RDFXML]: https://ruby-rdf.github.io/rdf-rdfxml
509+
[RDF::TriG]: https://ruby-rdf.github.io/rdf-trig
510+
[RDF::TriX]: https://ruby-rdf.github.io/rdf-trix
511+
[RDF::Turtle]: https://ruby-rdf.github.io/rdf-turtle
512+
[RDF::Raptor]: https://ruby-rdf.github.io/rdf-raptor
513513
[RDF*]: https://w3c.github.io/rdf-star/rdf-star-cg-spec.html
514-
[LinkedData]: https://ruby-rdf.github.com/linkeddata
515-
[JSON::LD]: https://ruby-rdf.github.com/json-ld
514+
[LinkedData]: https://ruby-rdf.github.io/linkeddata
515+
[JSON::LD]: https://ruby-rdf.github.io/json-ld
516516
[RestClient]: https://rubygems.org/gems/rest-client
517517
[RestClient Components]: https://rubygems.org/gems/rest-client-components
518518
[Rack::Cache]: https://rtomayko.github.io/rack-cache/

‎rdf.gemspec‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Gem::Specification.new do |gem|
1111
gem.summary = 'A Ruby library for working with Resource Description Framework (RDF) data.'
1212
gem.description = 'RDF.rb is a pure-Ruby library for working with Resource Description Framework (RDF) data.'
1313
gem.metadata = {
14-
"documentation_uri" => "https://rubydoc.info/github/ruby-rdf/rdf",
14+
"documentation_uri" => "https://ruby-rdf.github.io/rdf",
1515
"bug_tracker_uri" => "https://github.com/ruby-rdf/rdf/issues",
16-
"homepage_uri" => "https://ruby-rdf.github.io/rdf",
16+
"homepage_uri" => "https://github.com/ruby-rdf/rdf",
1717
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
1818
"source_code_uri" => "https://github.com/ruby-rdf/rdf",
1919
}

‎spec/model_graph_spec.rb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616

1717
context "as method" do
1818
it "with keyword arg" do
19-
expect(described_class).to receive(:new).with(graph_name: "http://ruby-rdf.github.com/rdf/etc/doap.nt")
20-
RDF::Graph(graph_name: "http://ruby-rdf.github.com/rdf/etc/doap.nt")
19+
expect(described_class).to receive(:new).with(graph_name: "https://ruby-rdf.github.io/rdf/etc/doap.nt")
20+
RDF::Graph(graph_name: "https://ruby-rdf.github.io/rdf/etc/doap.nt")
2121
end
2222

2323
it "with positional arg (removed)" do
2424
expect {
25-
RDF::Graph("http://ruby-rdf.github.com/rdf/etc/doap.nt")
25+
RDF::Graph("https://ruby-rdf.github.io/rdf/etc/doap.nt")
2626
}.to raise_error(ArgumentError)
2727
end
2828
end
@@ -47,15 +47,15 @@
4747

4848
context "named graphs" do
4949
subject {
50-
described_class.new(graph_name: "http://ruby-rdf.github.com/rdf/etc/doap.nt", data: RDF::Repository.new)
50+
described_class.new(graph_name: "https://ruby-rdf.github.io/rdf/etc/doap.nt", data: RDF::Repository.new)
5151
}
5252
it "should be instantiable" do
5353
expect { subject }.to_not raise_error
5454
end
5555

5656
it "should not be instantiable with positional arg" do
5757
expect {
58-
described_class.new("http://ruby-rdf.github.com/rdf/etc/doap.nt", data: RDF::Repository.new)
58+
described_class.new("https://ruby-rdf.github.io/rdf/etc/doap.nt", data: RDF::Repository.new)
5959
}.to raise_error(ArgumentError)
6060
end
6161

‎spec/readme_spec.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
{
5353
example0: lambda {
5454
require 'rdf/ntriples'
55-
RDF::NTriples::Reader.open("http://ruby-rdf.github.com/rdf/etc/doap.nt") do |reader|
55+
RDF::NTriples::Reader.open("https://ruby-rdf.github.io/rdf/etc/doap.nt") do |reader|
5656
reader.each_statement do |statement|
5757
puts statement.inspect
5858
end
@@ -72,7 +72,7 @@
7272
subject {
7373
if example == :example0
7474
expect(RDF::Util::File).to receive(:open_file).
75-
with("http://ruby-rdf.github.com/rdf/etc/doap.nt", hash_including(:headers)).
75+
with("https://ruby-rdf.github.io/rdf/etc/doap.nt", hash_including(:headers)).
7676
at_least(1).
7777
and_yield(Kernel.open(File.expand_path("../../etc/doap.nt", __FILE__)))
7878
end
@@ -90,7 +90,7 @@
9090
example0: lambda {
9191
require 'rdf/nquads'
9292

93-
graph = RDF::Graph.load("http://ruby-rdf.github.com/rdf/etc/doap.nq", format: :nquads)
93+
graph = RDF::Graph.load("https://ruby-rdf.github.io/rdf/etc/doap.nq", format: :nquads)
9494
graph.each_statement do |statement|
9595
puts statement.inspect
9696
end
@@ -109,7 +109,7 @@
109109
subject {
110110
if example == :example0
111111
expect(RDF::Util::File).to receive(:open_file).
112-
with("http://ruby-rdf.github.com/rdf/etc/doap.nq", hash_including(:headers, base_uri: "http://ruby-rdf.github.com/rdf/etc/doap.nq")).
112+
with("https://ruby-rdf.github.io/rdf/etc/doap.nq", hash_including(:headers, base_uri: "https://ruby-rdf.github.io/rdf/etc/doap.nq")).
113113
at_least(1).
114114
and_yield(Kernel.open(File.expand_path("../../etc/doap.nq", __FILE__)))
115115
end

‎spec/util_file_spec.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
end
8484

8585
describe ".open_file" do
86-
let(:uri) {"http://ruby-rdf.github.com/rdf/etc/doap.nt"}
86+
let(:uri) {"https://ruby-rdf.github.io/rdf/etc/doap.nt"}
8787
let(:opened) {double("opened")}
8888
before(:each) do
8989
expect(opened).to receive(:opened)

0 commit comments

Comments
 (0)