Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .github/workflows/archive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,25 @@ jobs:
cache-key: "renoise-xrnx"

- name: Install mdbook
run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0
run: cargo install mdbook@^0.5

- name: Build the API
run: cargo run

- name: Build the book
run: mdbook build

- name: Validate links
uses: lycheeverse/lychee-action@v2
with:
args: --no-progress --offline --root-dir "$GITHUB_WORKSPACE/book" book
fail: true

- name: Create XRNX_Starter_Pack
run: |
mkdir dist
cp -rf definitions dist/definitions
cp -rf book/html dist/docs
cp -rf book dist/docs
cp -rf tools dist/tools
rm -rf dist/*/.git dist/*/.gitignore
echo -e '<html>\n<body>\n<script type="text/javascript">\n\twindow.location.href = "./docs/index.html";\n</script>\n</body>\n</html>' > dist/docs.html
Expand Down
12 changes: 9 additions & 3 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,31 @@ jobs:

- name: Install Rust
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
with:
cache-workspaces: "docs"
cache-key: "renoise-xrnx"

- name: Install mdbook
run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0
run: cargo install mdbook@^0.5

- name: Build the API
run: cargo run

- name: Build the book
run: mdbook build

- name: Validate links
uses: lycheeverse/lychee-action@v2
with:
args: --no-progress --offline --root-dir "$GITHUB_WORKSPACE/book" book
fail: true

- name: Upload
uses: actions/upload-pages-artifact@v3
with:
name: github-pages
path: ./book/html

deploy:
# Add a dependency to the build job
needs: build
Expand Down
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
Cargo.lock
/book/
/dist/
/docs/API/builtins
/docs/API/renoise
/docs/API/renoise.md
/docs/API/modules
/generate/Cargo.lock
/generate/target/
/generate/lua-language-server/
/target/
/target/
5 changes: 2 additions & 3 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
The docs are generated using [mdBook](https://github.com/rust-lang/mdBook). To preview the pages locally you will need [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to install mdbook, mdbook-linkcheck and mdbook-toc.

```sh
# or `binstall`, to fetch latest binaries
cargo install mdbook mdbook-linkcheck mdbook-toc mdbook-alerts
cargo install mdbook@^0.5 # or `binstall` to fetch binaries
```

### Building
Expand All @@ -19,4 +18,4 @@ mdbook serve --open

### Generate API reference

See [generate/README.md](./generate/README.md)
See [generate/README.md](./generate/README.md)
10 changes: 3 additions & 7 deletions book.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[book]
authors = ["renoise"]
language = "en"
multilingual = false
src = "docs"
title = "Renoise Scripting"

Expand All @@ -12,12 +11,9 @@ create-missing = false
default-theme = "dark"
preferred-dark-theme = "ayu"
git-repository-url = "https://github.com/renoise/xrnx"
git-repository-icon = "fa-github"
edit-url-template = "https://github.com/renoise/xrnx/edit/master/{path}"
additional-css = [ "docs/styles.css" ]
sidebar-header-nav = false

[output.linkcheck]
warning-policy = "ignore"

[preprocessor.toc]
[preprocessor.alerts]
[output.html.search]
limit-results = 100
2 changes: 1 addition & 1 deletion definitions
3 changes: 0 additions & 3 deletions docs/API/builtins/any.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/boolean.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/function.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/integer.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/lightuserdata.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/nil.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/number.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/API/builtins/self.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/string.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/table.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/unknown.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/API/builtins/userdata.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/API/modules/debug.md

This file was deleted.

102 changes: 0 additions & 102 deletions docs/API/modules/global.md

This file was deleted.

70 changes: 0 additions & 70 deletions docs/API/modules/io.md

This file was deleted.

Loading
Loading