Skip to content

Commit 23ac4a5

Browse files
wmedranowmedrano
authored
Add documentation (#207)
* Add documentation. * Autopublish on push to main branch.
1 parent 12e9124 commit 23ac4a5

File tree

9 files changed

+457
-1
lines changed

9 files changed

+457
-1
lines changed

‎.github/workflows/site.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: publish_site
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
# Allows you to run this workflow manually from the Actions tab
8+
workflow_dispatch:
9+
10+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub
11+
# Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between
18+
# the run in-progress and latest queued. However, do NOT cancel
19+
# in-progress runs as we want to allow these production deployments to
20+
# complete.
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: false
24+
25+
jobs:
26+
build-site:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Ruby
32+
uses: ruby/setup-ruby@v1
33+
with:
34+
ruby-version: 3.0
35+
bundler-cache: true
36+
cache-version: 0 # Increment this number to re-download cached gems.
37+
- name: Setup Pages
38+
id: pages
39+
uses: actions/configure-pages@v5
40+
- name: Build with Jekyll
41+
run: |
42+
bundle install
43+
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
44+
working-directory: ./docs
45+
env:
46+
JEKYLL_ENV: production
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
path: ./docs/_site
51+
deploy-site:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build-site
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

‎README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Rust bindings for [JACK Audio Connection Kit](<https://jackaudio.org>).
55
| [![Crates.io](https://img.shields.io/crates/v/jack.svg)](https://crates.io/crates/jack) | [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
66
|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
77
| [![Docs.rs](https://docs.rs/jack/badge.svg)](https://docs.rs/jack) | [![Test](https://github.com/RustAudio/rust-jack/actions/workflows/testing.yml/badge.svg)](https://github.com/RustAudio/rust-jack/actions/workflows/testing.yml) |
8-
| | [:heart: Sponsor](<https://github.com/sponsors/wmedrano>) |
8+
| [Documentation](https://rustaudio.github.io/rust-jack) | [:heart: Sponsor](<https://github.com/sponsors/wmedrano>) |
99

1010
## Using JACK
1111

@@ -46,6 +46,9 @@ run in single threaded mode.
4646

4747
If the tests are failing, a possible gotcha may be timing issues.
4848

49+
1. If using `cargo test`, try `cargo nextest`. The `cargo nextest`
50+
configuration is set up to run single threaded and to retry flaky tests up
51+
to 3 times.
4952
1. Increase the value used by `sleep_on_test` in `client/common.rs`.
5053

5154
Another case is that libjack may be broken on your setup. Try using libjack2 or

‎docs/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor

‎docs/404.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: default
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎docs/Gemfile

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.3.3"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
# gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
end
20+
21+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
22+
# and associated library.
23+
platforms :mingw, :x64_mingw, :mswin, :jruby do
24+
gem "tzinfo", ">= 1", "< 3"
25+
gem "tzinfo-data"
26+
end
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
30+
31+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
32+
# do not have a Java counterpart.
33+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
34+
gem "jekyll-mermaid"
35+
gem "just-the-docs"

‎docs/Gemfile.lock

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
bigdecimal (3.1.8)
7+
colorator (1.1.0)
8+
concurrent-ruby (1.3.4)
9+
em-websocket (0.5.3)
10+
eventmachine (>= 0.12.9)
11+
http_parser.rb (~> 0)
12+
eventmachine (1.2.7)
13+
ffi (1.17.0)
14+
ffi (1.17.0-aarch64-linux-gnu)
15+
ffi (1.17.0-aarch64-linux-musl)
16+
ffi (1.17.0-arm-linux-gnu)
17+
ffi (1.17.0-arm-linux-musl)
18+
ffi (1.17.0-arm64-darwin)
19+
ffi (1.17.0-x86-linux-gnu)
20+
ffi (1.17.0-x86-linux-musl)
21+
ffi (1.17.0-x86_64-darwin)
22+
ffi (1.17.0-x86_64-linux-gnu)
23+
ffi (1.17.0-x86_64-linux-musl)
24+
forwardable-extended (2.6.0)
25+
google-protobuf (4.28.1)
26+
bigdecimal
27+
rake (>= 13)
28+
google-protobuf (4.28.1-aarch64-linux)
29+
bigdecimal
30+
rake (>= 13)
31+
google-protobuf (4.28.1-arm64-darwin)
32+
bigdecimal
33+
rake (>= 13)
34+
google-protobuf (4.28.1-x86-linux)
35+
bigdecimal
36+
rake (>= 13)
37+
google-protobuf (4.28.1-x86_64-darwin)
38+
bigdecimal
39+
rake (>= 13)
40+
google-protobuf (4.28.1-x86_64-linux)
41+
bigdecimal
42+
rake (>= 13)
43+
http_parser.rb (0.8.0)
44+
i18n (1.14.5)
45+
concurrent-ruby (~> 1.0)
46+
jekyll (4.3.3)
47+
addressable (~> 2.4)
48+
colorator (~> 1.0)
49+
em-websocket (~> 0.5)
50+
i18n (~> 1.0)
51+
jekyll-sass-converter (>= 2.0, < 4.0)
52+
jekyll-watch (~> 2.0)
53+
kramdown (~> 2.3, >= 2.3.1)
54+
kramdown-parser-gfm (~> 1.0)
55+
liquid (~> 4.0)
56+
mercenary (>= 0.3.6, < 0.5)
57+
pathutil (~> 0.9)
58+
rouge (>= 3.0, < 5.0)
59+
safe_yaml (~> 1.0)
60+
terminal-table (>= 1.8, < 4.0)
61+
webrick (~> 1.7)
62+
jekyll-feed (0.17.0)
63+
jekyll (>= 3.7, < 5.0)
64+
jekyll-include-cache (0.2.1)
65+
jekyll (>= 3.7, < 5.0)
66+
jekyll-mermaid (1.0.0)
67+
jekyll-sass-converter (3.0.0)
68+
sass-embedded (~> 1.54)
69+
jekyll-seo-tag (2.8.0)
70+
jekyll (>= 3.8, < 5.0)
71+
jekyll-watch (2.2.1)
72+
listen (~> 3.0)
73+
just-the-docs (0.10.0)
74+
jekyll (>= 3.8.5)
75+
jekyll-include-cache
76+
jekyll-seo-tag (>= 2.0)
77+
rake (>= 12.3.1)
78+
kramdown (2.4.0)
79+
rexml
80+
kramdown-parser-gfm (1.1.0)
81+
kramdown (~> 2.0)
82+
liquid (4.0.4)
83+
listen (3.9.0)
84+
rb-fsevent (~> 0.10, >= 0.10.3)
85+
rb-inotify (~> 0.9, >= 0.9.10)
86+
mercenary (0.4.0)
87+
minima (2.5.2)
88+
jekyll (>= 3.5, < 5.0)
89+
jekyll-feed (~> 0.9)
90+
jekyll-seo-tag (~> 2.1)
91+
pathutil (0.16.2)
92+
forwardable-extended (~> 2.6)
93+
public_suffix (6.0.1)
94+
rake (13.2.1)
95+
rb-fsevent (0.11.2)
96+
rb-inotify (0.11.1)
97+
ffi (~> 1.0)
98+
rexml (3.3.7)
99+
rouge (4.3.0)
100+
safe_yaml (1.0.5)
101+
sass-embedded (1.78.0)
102+
google-protobuf (~> 4.27)
103+
rake (>= 13)
104+
sass-embedded (1.78.0-aarch64-linux-android)
105+
google-protobuf (~> 4.27)
106+
sass-embedded (1.78.0-aarch64-linux-gnu)
107+
google-protobuf (~> 4.27)
108+
sass-embedded (1.78.0-aarch64-linux-musl)
109+
google-protobuf (~> 4.27)
110+
sass-embedded (1.78.0-aarch64-mingw-ucrt)
111+
google-protobuf (~> 4.27)
112+
sass-embedded (1.78.0-arm-linux-androideabi)
113+
google-protobuf (~> 4.27)
114+
sass-embedded (1.78.0-arm-linux-gnueabihf)
115+
google-protobuf (~> 4.27)
116+
sass-embedded (1.78.0-arm-linux-musleabihf)
117+
google-protobuf (~> 4.27)
118+
sass-embedded (1.78.0-arm64-darwin)
119+
google-protobuf (~> 4.27)
120+
sass-embedded (1.78.0-riscv64-linux-android)
121+
google-protobuf (~> 4.27)
122+
sass-embedded (1.78.0-riscv64-linux-gnu)
123+
google-protobuf (~> 4.27)
124+
sass-embedded (1.78.0-riscv64-linux-musl)
125+
google-protobuf (~> 4.27)
126+
sass-embedded (1.78.0-x86-cygwin)
127+
google-protobuf (~> 4.27)
128+
sass-embedded (1.78.0-x86-linux-android)
129+
google-protobuf (~> 4.27)
130+
sass-embedded (1.78.0-x86-linux-gnu)
131+
google-protobuf (~> 4.27)
132+
sass-embedded (1.78.0-x86-linux-musl)
133+
google-protobuf (~> 4.27)
134+
sass-embedded (1.78.0-x86-mingw-ucrt)
135+
google-protobuf (~> 4.27)
136+
sass-embedded (1.78.0-x86_64-cygwin)
137+
google-protobuf (~> 4.27)
138+
sass-embedded (1.78.0-x86_64-darwin)
139+
google-protobuf (~> 4.27)
140+
sass-embedded (1.78.0-x86_64-linux-android)
141+
google-protobuf (~> 4.27)
142+
sass-embedded (1.78.0-x86_64-linux-gnu)
143+
google-protobuf (~> 4.27)
144+
sass-embedded (1.78.0-x86_64-linux-musl)
145+
google-protobuf (~> 4.27)
146+
terminal-table (3.0.2)
147+
unicode-display_width (>= 1.1.1, < 3)
148+
unicode-display_width (2.5.0)
149+
webrick (1.8.1)
150+
151+
PLATFORMS
152+
aarch64-linux
153+
aarch64-linux-android
154+
aarch64-linux-gnu
155+
aarch64-linux-musl
156+
aarch64-mingw-ucrt
157+
arm-linux-androideabi
158+
arm-linux-gnu
159+
arm-linux-gnueabihf
160+
arm-linux-musl
161+
arm-linux-musleabihf
162+
arm64-darwin
163+
riscv64-linux-android
164+
riscv64-linux-gnu
165+
riscv64-linux-musl
166+
ruby
167+
x86-cygwin
168+
x86-linux
169+
x86-linux-android
170+
x86-linux-gnu
171+
x86-linux-musl
172+
x86-mingw-ucrt
173+
x86_64-cygwin
174+
x86_64-darwin
175+
x86_64-linux-android
176+
x86_64-linux-gnu
177+
x86_64-linux-musl
178+
179+
DEPENDENCIES
180+
http_parser.rb (~> 0.6.0)
181+
jekyll (~> 4.3.3)
182+
jekyll-feed (~> 0.12)
183+
jekyll-mermaid
184+
just-the-docs
185+
minima (~> 2.5)
186+
tzinfo (>= 1, < 3)
187+
tzinfo-data
188+
wdm (~> 0.1.1)
189+
190+
BUNDLED WITH
191+
2.5.17

‎docs/_config.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Demo with: bundle exec jekyll serve
2+
title: Rust JACK
3+
email: [email protected]
4+
description: >-
5+
Rust bindings for JACK
6+
baseurl: "/" # the subpath of your site, e.g. /blog
7+
url: "https://rustaudio.github.io/rust-jack"
8+
github_username: wmedrano
9+
theme: just-the-docs
10+
mermaid:
11+
src: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js'
12+
plugins:
13+
- jekyll-feed
14+
- jekyll-mermaid
15+
aux_links:
16+
"GitHub":
17+
- "https://github.com/rustaudio/rust-jack"
18+
"Sponsor":
19+
- "https://github.com/sponsors/wmedrano"
20+
callouts:
21+
todo:
22+
title: TODO
23+
color: yellow
24+
warning:
25+
title: Warning
26+
color: red

‎docs/qjackctl.png

60.4 KB
Loading

0 commit comments

Comments
 (0)