Skip to content

Commit db405a1

Browse files
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent 1519d66 commit db405a1

4 files changed

Lines changed: 36 additions & 2 deletions

File tree

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
@@ -103,5 +103,5 @@ see <https://unlicense.org/> or the accompanying {file:UNLICENSE} file.
103103
[YARD]: https://yardoc.org/
104104
[YARD-GS]: https://rubydoc.info/docs/yard/file/docs/GettingStarted.md
105105
[PDD]: https://unlicense.org/#unlicensing-contributions
106-
[RDF/XML doc]: https://rubydoc.info/github/ruby-rdf/rdf-rdfxml/master/frames
106+
[RDF/XML doc]: https://ruby-rdf.github.io/rdf-rdfxml/master/frames
107107
[RDF-star]: https://w3c.github.io/rdf-star/rdf-star-cg-spec.html

lib/rdf/rdfxml/writer.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class Writer < RDF::RDFa::Writer
5555

5656
##
5757
# RDF/XML Writer options
58-
# @see http://www.rubydoc.info/github/ruby-rdf/rdf/RDF/Writer#options-class_method
58+
# @see https://ruby-rdf.github.io/rdf/RDF/Writer#options-class_method
5959
def self.options
6060
super + [
6161
RDF::CLI::Option.new(

rdf-rdfxml.gemspec

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Gem::Specification.new do |gem|
1010
gem.license = 'Unlicense'
1111
gem.summary = %q{RDF/XML reader/writer for RDF.rb.}
1212
gem.description = %q{RDF::RDFXML is an RDF/XML reader and writer for the RDF.rb library suite.}
13+
gem.metadata = {
14+
"documentation_uri" => "https://ruby-rdf.github.io/rdf-rdfxml",
15+
"bug_tracker_uri" => "https://github.com/ruby-rdf/rdf-rdfxml/issues",
16+
"homepage_uri" => "https://github.com/ruby-rdf/rdf-rdfxml",
17+
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
18+
"source_code_uri" => "https://github.com/ruby-rdf/rdf-rdfxml",
19+
}
1320

1421
gem.authors = %w(Gregg Kellogg)
1522
gem.email = 'public-rdf-ruby@w3.org'

0 commit comments

Comments
 (0)