From 7451f03a48a3d2b46288d684323f8bc053f38466 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isa=C3=AFe?= Date: Thu, 9 May 2024 20:42:16 +0200 Subject: [PATCH] chore: improve various integration stuff (#9) * add a tracker issue template * add a changelog file * add an index.html file for GH pages root * add css & more stuff to the html * add shell script to add docs files to rustdoc * update CI to deploy additional files * fix punctuation --- .github/ISSUE_TEMPLATE/8-tracker.md | 11 ++++++++ .github/ISSUE_TEMPLATE/9-release.md | 2 +- .github/workflows/doc.yml | 7 +++-- CHANGELOG.md | 9 ++++++ docs/build.sh | 2 ++ docs/index.css | 43 +++++++++++++++++++++++++++++ docs/index.html | 33 ++++++++++++++++++++++ 7 files changed, 104 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/8-tracker.md create mode 100644 CHANGELOG.md create mode 100644 docs/build.sh create mode 100644 docs/index.css create mode 100644 docs/index.html diff --git a/.github/ISSUE_TEMPLATE/8-tracker.md b/.github/ISSUE_TEMPLATE/8-tracker.md new file mode 100644 index 0000000..42dff0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/8-tracker.md @@ -0,0 +1,11 @@ +--- +name: Tracker +about: Use this template to create an issue tracking larger changes. +title: "tracker: title" +labels: tracker, +assignees: +--- + +small description of what's tracked + +- [ ] ... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/9-release.md b/.github/ISSUE_TEMPLATE/9-release.md index b193efb..d65cc74 100644 --- a/.github/ISSUE_TEMPLATE/9-release.md +++ b/.github/ISSUE_TEMPLATE/9-release.md @@ -1,7 +1,7 @@ --- name: Release about: For maintainers. -title: "rel: " +title: "release: " labels: release, assignees: --- diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index fb89eeb..93fc78d 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -19,11 +19,14 @@ jobs: - uses: actions/checkout@v4 with: submodules: recursive - # Need to refine this by specifying components required for doc + # Rust doc - uses: dtolnay/rust-toolchain@nightly - name: Generate Rust Docs run: cargo +nightly doc --all --all-features --no-deps - + # Additional files + - run: sudo chmod +x ./docs/build.sh + - run: sudo ./docs/build.sh + # Deployments - name: Deploy Docs uses: peaceiris/actions-gh-pages@v3 with: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d012941 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog + +Integraal aims to provide generic and efficient tools for numerical integration in the Rust Programming Language. + +--- + +## To be released + +A feature list will be written for the first non-alpha release (i.e. `0.1.0`) \ No newline at end of file diff --git a/docs/build.sh b/docs/build.sh new file mode 100644 index 0000000..63d5e20 --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,2 @@ +cp docs/index.html target/doc +cp docs/index.css target/doc \ No newline at end of file diff --git a/docs/index.css b/docs/index.css new file mode 100644 index 0000000..faede9d --- /dev/null +++ b/docs/index.css @@ -0,0 +1,43 @@ +/* Ayu-like theme */ +html { + background-color: #826754; + height: 100%; +} + +body { + max-width: 70ch; + margin: auto; + padding: 1em; + text-align: left; + background-color: #FFD5C280; + height: 100%; +} + +h1 { + font-family: Helvetica; + color: #473320; +} + +h2 { + font-family: Helvetica; + color: #704E2E; +} + +p { + font-family: Helvetica; + color: #5a3f25; +} + +li { + color: #5a3f25; +} + +a:link { + color: #A33B20; + text-decoration: none; +} + +a:visited { + color: #A33B20; + text-decoration: none; +} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..031520e --- /dev/null +++ b/docs/index.html @@ -0,0 +1,33 @@ + +Integraal Project + + + + +

integraal

+ +

scope of the project

+ +

+ Integraal is a Rust crate that aims to provide generic and efficient tools for + numerical integration + in the Rust Programming Language. +

+ The goal is to create a portable tool that handles executing the computational code, + relying on information specified by the user for integral description. This can be + implemented in an elegant, ergonomic manner thanks to the language's features, most + notably traits. +

+ The crate should support multiple numerical integration methods (e.g. rectangles, + trapezoids, ...) as well as multiple execution policies (e.g. sequential, parallel + on CPU, ...) in order to cover as much use cases as possible. +

+ +

links

+ + \ No newline at end of file