Skip to content

Commit fd969cb

Browse files
rgaignaultrgaignault
committed
index
1 parent 0a87d0b commit fd969cb

File tree

215 files changed

+3229
-1243
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

215 files changed

+3229
-1243
lines changed

‎.github/workflows/api-docs-release.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Publish API Documentation on Release
2+
3+
permissions:
4+
contents: read
5+
pages: write
6+
id-token: write
7+
8+
on:
9+
push:
10+
branches:
11+
- romanG/api-reference
12+
tags:
13+
- 'v*.*.*'
14+
workflow_dispatch:
15+
16+
concurrency:
17+
group: 'api-docs-release'
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build-and-deploy:
22+
runs-on: ubuntu-latest
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
26+
27+
steps:
28+
- name: Checkout code
29+
uses: actions/checkout@v4
30+
with:
31+
fetch-depth: 0
32+
33+
- name: Setup Node.js
34+
uses: actions/setup-node@v4
35+
with:
36+
node-version: '18'
37+
cache: 'yarn'
38+
39+
- name: Setup Ruby
40+
uses: ruby/setup-ruby@v1
41+
with:
42+
ruby-version: '3.1'
43+
bundler-cache: true
44+
45+
- name: Install Node dependencies
46+
run: yarn install --frozen-lockfile
47+
48+
- name: Build TS declarations
49+
run: yarn build
50+
51+
- name: Build types and generate API docs
52+
run: |
53+
echo "Building API documentation for version ${{ steps.version.outputs.version }}"
54+
yarn docs:api
55+
56+
- name: Setup Pages
57+
uses: actions/configure-pages@v4
58+
59+
- name: Build with Jekyll
60+
run: |
61+
bundle exec jekyll build --source docs --destination _site
62+
env:
63+
JEKYLL_ENV: production
64+
PAGES_REPO_NWO: ${{ github.repository }}
65+
66+
- name: Upload artifact
67+
uses: actions/upload-pages-artifact@v3
68+
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v4

‎.github/workflows/pages.yml‎

Whitespace-only changes.

‎Gemfile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
source "https://rubygems.org"
2+
3+
gem "github-pages", group: :jekyll_plugins
4+
5+
group :jekyll_plugins do
6+
gem "jekyll-feed"
7+
gem "jekyll-sitemap"
8+
gem "jekyll-seo-tag"
9+
gem "jekyll-relative-links"
10+
gem "jekyll-remote-theme"
11+
gem "jekyll-include-cache"
12+
end
13+
14+
gem "webrick", "~> 1.7"

‎Gemfile.lock‎

Lines changed: 311 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,311 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.2.2.1)
5+
base64
6+
benchmark (>= 0.3)
7+
bigdecimal
8+
concurrent-ruby (~> 1.0, >= 1.3.1)
9+
connection_pool (>= 2.2.5)
10+
drb
11+
i18n (>= 1.6, < 2)
12+
logger (>= 1.4.2)
13+
minitest (>= 5.1)
14+
securerandom (>= 0.3)
15+
tzinfo (~> 2.0, >= 2.0.5)
16+
addressable (2.8.7)
17+
public_suffix (>= 2.0.2, < 7.0)
18+
base64 (0.2.0)
19+
benchmark (0.4.1)
20+
bigdecimal (3.2.2)
21+
coffee-script (2.4.1)
22+
coffee-script-source
23+
execjs
24+
coffee-script-source (1.12.2)
25+
colorator (1.1.0)
26+
commonmarker (0.23.11)
27+
concurrent-ruby (1.3.5)
28+
connection_pool (2.5.3)
29+
dnsruby (1.72.4)
30+
base64 (~> 0.2.0)
31+
logger (~> 1.6.5)
32+
simpleidn (~> 0.2.1)
33+
drb (2.2.3)
34+
em-websocket (0.5.3)
35+
eventmachine (>= 0.12.9)
36+
http_parser.rb (~> 0)
37+
ethon (0.16.0)
38+
ffi (>= 1.15.0)
39+
eventmachine (1.2.7)
40+
execjs (2.10.0)
41+
faraday (2.13.1)
42+
faraday-net_http (>= 2.0, < 3.5)
43+
json
44+
logger
45+
faraday-net_http (3.4.1)
46+
net-http (>= 0.5.0)
47+
ffi (1.17.2-aarch64-linux-gnu)
48+
ffi (1.17.2-aarch64-linux-musl)
49+
ffi (1.17.2-arm-linux-gnu)
50+
ffi (1.17.2-arm-linux-musl)
51+
ffi (1.17.2-arm64-darwin)
52+
ffi (1.17.2-x86_64-darwin)
53+
ffi (1.17.2-x86_64-linux-gnu)
54+
ffi (1.17.2-x86_64-linux-musl)
55+
forwardable-extended (2.6.0)
56+
gemoji (4.1.0)
57+
github-pages (230)
58+
github-pages-health-check (= 1.18.2)
59+
jekyll (= 3.9.5)
60+
jekyll-avatar (= 0.8.0)
61+
jekyll-coffeescript (= 1.2.2)
62+
jekyll-commonmark-ghpages (= 0.4.0)
63+
jekyll-default-layout (= 0.1.5)
64+
jekyll-feed (= 0.17.0)
65+
jekyll-gist (= 1.5.0)
66+
jekyll-github-metadata (= 2.16.1)
67+
jekyll-include-cache (= 0.2.1)
68+
jekyll-mentions (= 1.6.0)
69+
jekyll-optional-front-matter (= 0.3.2)
70+
jekyll-paginate (= 1.1.0)
71+
jekyll-readme-index (= 0.3.0)
72+
jekyll-redirect-from (= 0.16.0)
73+
jekyll-relative-links (= 0.7.0)
74+
jekyll-remote-theme (= 0.4.3)
75+
jekyll-sass-converter (= 1.5.2)
76+
jekyll-seo-tag (= 2.8.0)
77+
jekyll-sitemap (= 1.4.0)
78+
jekyll-swiss (= 1.0.0)
79+
jekyll-theme-architect (= 0.2.0)
80+
jekyll-theme-cayman (= 0.2.0)
81+
jekyll-theme-dinky (= 0.2.0)
82+
jekyll-theme-hacker (= 0.2.0)
83+
jekyll-theme-leap-day (= 0.2.0)
84+
jekyll-theme-merlot (= 0.2.0)
85+
jekyll-theme-midnight (= 0.2.0)
86+
jekyll-theme-minimal (= 0.2.0)
87+
jekyll-theme-modernist (= 0.2.0)
88+
jekyll-theme-primer (= 0.6.0)
89+
jekyll-theme-slate (= 0.2.0)
90+
jekyll-theme-tactile (= 0.2.0)
91+
jekyll-theme-time-machine (= 0.2.0)
92+
jekyll-titles-from-headings (= 0.5.3)
93+
jemoji (= 0.13.0)
94+
kramdown (= 2.4.0)
95+
kramdown-parser-gfm (= 1.1.0)
96+
liquid (= 4.0.4)
97+
mercenary (~> 0.3)
98+
minima (= 2.5.1)
99+
nokogiri (>= 1.13.6, < 2.0)
100+
rouge (= 3.30.0)
101+
terminal-table (~> 1.4)
102+
github-pages-health-check (1.18.2)
103+
addressable (~> 2.3)
104+
dnsruby (~> 1.60)
105+
octokit (>= 4, < 8)
106+
public_suffix (>= 3.0, < 6.0)
107+
typhoeus (~> 1.3)
108+
html-pipeline (2.14.3)
109+
activesupport (>= 2)
110+
nokogiri (>= 1.4)
111+
http_parser.rb (0.8.0)
112+
i18n (1.14.7)
113+
concurrent-ruby (~> 1.0)
114+
jekyll (3.9.5)
115+
addressable (~> 2.4)
116+
colorator (~> 1.0)
117+
em-websocket (~> 0.5)
118+
i18n (>= 0.7, < 2)
119+
jekyll-sass-converter (~> 1.0)
120+
jekyll-watch (~> 2.0)
121+
kramdown (>= 1.17, < 3)
122+
liquid (~> 4.0)
123+
mercenary (~> 0.3.3)
124+
pathutil (~> 0.9)
125+
rouge (>= 1.7, < 4)
126+
safe_yaml (~> 1.0)
127+
jekyll-avatar (0.8.0)
128+
jekyll (>= 3.0, < 5.0)
129+
jekyll-coffeescript (1.2.2)
130+
coffee-script (~> 2.2)
131+
coffee-script-source (~> 1.12)
132+
jekyll-commonmark (1.4.0)
133+
commonmarker (~> 0.22)
134+
jekyll-commonmark-ghpages (0.4.0)
135+
commonmarker (~> 0.23.7)
136+
jekyll (~> 3.9.0)
137+
jekyll-commonmark (~> 1.4.0)
138+
rouge (>= 2.0, < 5.0)
139+
jekyll-default-layout (0.1.5)
140+
jekyll (>= 3.0, < 5.0)
141+
jekyll-feed (0.17.0)
142+
jekyll (>= 3.7, < 5.0)
143+
jekyll-gist (1.5.0)
144+
octokit (~> 4.2)
145+
jekyll-github-metadata (2.16.1)
146+
jekyll (>= 3.4, < 5.0)
147+
octokit (>= 4, < 7, != 4.4.0)
148+
jekyll-include-cache (0.2.1)
149+
jekyll (>= 3.7, < 5.0)
150+
jekyll-mentions (1.6.0)
151+
html-pipeline (~> 2.3)
152+
jekyll (>= 3.7, < 5.0)
153+
jekyll-optional-front-matter (0.3.2)
154+
jekyll (>= 3.0, < 5.0)
155+
jekyll-paginate (1.1.0)
156+
jekyll-readme-index (0.3.0)
157+
jekyll (>= 3.0, < 5.0)
158+
jekyll-redirect-from (0.16.0)
159+
jekyll (>= 3.3, < 5.0)
160+
jekyll-relative-links (0.7.0)
161+
jekyll (>= 3.3, < 5.0)
162+
jekyll-remote-theme (0.4.3)
163+
addressable (~> 2.0)
164+
jekyll (>= 3.5, < 5.0)
165+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
166+
rubyzip (>= 1.3.0, < 3.0)
167+
jekyll-sass-converter (1.5.2)
168+
sass (~> 3.4)
169+
jekyll-seo-tag (2.8.0)
170+
jekyll (>= 3.8, < 5.0)
171+
jekyll-sitemap (1.4.0)
172+
jekyll (>= 3.7, < 5.0)
173+
jekyll-swiss (1.0.0)
174+
jekyll-theme-architect (0.2.0)
175+
jekyll (> 3.5, < 5.0)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-cayman (0.2.0)
178+
jekyll (> 3.5, < 5.0)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-dinky (0.2.0)
181+
jekyll (> 3.5, < 5.0)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-hacker (0.2.0)
184+
jekyll (> 3.5, < 5.0)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-leap-day (0.2.0)
187+
jekyll (> 3.5, < 5.0)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-theme-merlot (0.2.0)
190+
jekyll (> 3.5, < 5.0)
191+
jekyll-seo-tag (~> 2.0)
192+
jekyll-theme-midnight (0.2.0)
193+
jekyll (> 3.5, < 5.0)
194+
jekyll-seo-tag (~> 2.0)
195+
jekyll-theme-minimal (0.2.0)
196+
jekyll (> 3.5, < 5.0)
197+
jekyll-seo-tag (~> 2.0)
198+
jekyll-theme-modernist (0.2.0)
199+
jekyll (> 3.5, < 5.0)
200+
jekyll-seo-tag (~> 2.0)
201+
jekyll-theme-primer (0.6.0)
202+
jekyll (> 3.5, < 5.0)
203+
jekyll-github-metadata (~> 2.9)
204+
jekyll-seo-tag (~> 2.0)
205+
jekyll-theme-slate (0.2.0)
206+
jekyll (> 3.5, < 5.0)
207+
jekyll-seo-tag (~> 2.0)
208+
jekyll-theme-tactile (0.2.0)
209+
jekyll (> 3.5, < 5.0)
210+
jekyll-seo-tag (~> 2.0)
211+
jekyll-theme-time-machine (0.2.0)
212+
jekyll (> 3.5, < 5.0)
213+
jekyll-seo-tag (~> 2.0)
214+
jekyll-titles-from-headings (0.5.3)
215+
jekyll (>= 3.3, < 5.0)
216+
jekyll-watch (2.2.1)
217+
listen (~> 3.0)
218+
jemoji (0.13.0)
219+
gemoji (>= 3, < 5)
220+
html-pipeline (~> 2.2)
221+
jekyll (>= 3.0, < 5.0)
222+
json (2.12.2)
223+
kramdown (2.4.0)
224+
rexml
225+
kramdown-parser-gfm (1.1.0)
226+
kramdown (~> 2.0)
227+
liquid (4.0.4)
228+
listen (3.9.0)
229+
rb-fsevent (~> 0.10, >= 0.10.3)
230+
rb-inotify (~> 0.9, >= 0.9.10)
231+
logger (1.6.6)
232+
mercenary (0.3.6)
233+
minima (2.5.1)
234+
jekyll (>= 3.5, < 5.0)
235+
jekyll-feed (~> 0.9)
236+
jekyll-seo-tag (~> 2.1)
237+
minitest (5.25.5)
238+
net-http (0.6.0)
239+
uri
240+
nokogiri (1.18.8-aarch64-linux-gnu)
241+
racc (~> 1.4)
242+
nokogiri (1.18.8-aarch64-linux-musl)
243+
racc (~> 1.4)
244+
nokogiri (1.18.8-arm-linux-gnu)
245+
racc (~> 1.4)
246+
nokogiri (1.18.8-arm-linux-musl)
247+
racc (~> 1.4)
248+
nokogiri (1.18.8-arm64-darwin)
249+
racc (~> 1.4)
250+
nokogiri (1.18.8-x86_64-darwin)
251+
racc (~> 1.4)
252+
nokogiri (1.18.8-x86_64-linux-gnu)
253+
racc (~> 1.4)
254+
nokogiri (1.18.8-x86_64-linux-musl)
255+
racc (~> 1.4)
256+
octokit (4.25.1)
257+
faraday (>= 1, < 3)
258+
sawyer (~> 0.9)
259+
pathutil (0.16.2)
260+
forwardable-extended (~> 2.6)
261+
public_suffix (5.1.1)
262+
racc (1.8.1)
263+
rb-fsevent (0.11.2)
264+
rb-inotify (0.11.1)
265+
ffi (~> 1.0)
266+
rexml (3.4.1)
267+
rouge (3.30.0)
268+
rubyzip (2.4.1)
269+
safe_yaml (1.0.5)
270+
sass (3.7.4)
271+
sass-listen (~> 4.0.0)
272+
sass-listen (4.0.0)
273+
rb-fsevent (~> 0.9, >= 0.9.4)
274+
rb-inotify (~> 0.9, >= 0.9.7)
275+
sawyer (0.9.2)
276+
addressable (>= 2.3.5)
277+
faraday (>= 0.17.3, < 3)
278+
securerandom (0.4.1)
279+
simpleidn (0.2.3)
280+
terminal-table (1.8.0)
281+
unicode-display_width (~> 1.1, >= 1.1.1)
282+
typhoeus (1.4.1)
283+
ethon (>= 0.9.0)
284+
tzinfo (2.0.6)
285+
concurrent-ruby (~> 1.0)
286+
unicode-display_width (1.8.0)
287+
uri (1.0.3)
288+
webrick (1.9.1)
289+
290+
PLATFORMS
291+
aarch64-linux-gnu
292+
aarch64-linux-musl
293+
arm-linux-gnu
294+
arm-linux-musl
295+
arm64-darwin
296+
x86_64-darwin
297+
x86_64-linux-gnu
298+
x86_64-linux-musl
299+
300+
DEPENDENCIES
301+
github-pages
302+
jekyll-feed
303+
jekyll-include-cache
304+
jekyll-relative-links
305+
jekyll-remote-theme
306+
jekyll-seo-tag
307+
jekyll-sitemap
308+
webrick (~> 1.7)
309+
310+
BUNDLED WITH
311+
2.6.9

0 commit comments

Comments
 (0)