Skip to content

Commit f51b8d5

Browse files
committed
Update documentation links to use gh-pages, and add action to publish gh-pages from Yard docs.
1 parent 9960e37 commit f51b8d5

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-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

rdf-ldp.gemspec

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

88
gem.name = 'rdf-ldp'
9-
gem.homepage = 'https://ruby-rdf.github.com/'
9+
gem.homepage = 'https://github.com/ruby-rdf/rdf-ldp'
1010
gem.license = 'Unlicense'
1111
gem.summary = 'A suite of LDP software and middleware for RDF.rb.'
1212
gem.description = 'Implements a Linked Data Platform domain model, ' \
1313
'Rack middleware for server implementers, and a ' \
1414
'simple Sinatra-based server for RDF.rb'
15+
gem.metadata = {
16+
"documentation_uri" => "https://ruby-rdf.github.io/rdf-ldp",
17+
"bug_tracker_uri" => "https://github.com/ruby-rdf/rdf-ldp/issues",
18+
"homepage_uri" => "https://github.com/ruby-rdf/rdf-ldp",
19+
"mailing_list_uri" => "https://lists.w3.org/Archives/Public/public-rdf-ruby/",
20+
"source_code_uri" => "https://github.com/ruby-rdf/rdf-ldp",
21+
}
1522

1623
gem.authors = ['Tom Johnson']
1724
gem.email = 'public-rdf-ruby@w3.org'

0 commit comments

Comments
 (0)