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
imrn99 · May 9, 2024 · 7451f03 · 7451f03
1 parent 30fa7e6
commit 7451f03
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/8-tracker.md 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
+
+- [ ] ...
diff --git 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: <version number>"
+title: "release: <version number>"
 labels: release,
 assignees:
 ---

diff --git 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
@@ -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`)
diff --git a/docs/build.sh b/docs/build.sh
@@ -0,0 +1,2 @@
+cp docs/index.html target/doc
+cp docs/index.css target/doc
diff --git a/docs/index.css 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;
+}
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<title>Integraal Project</title>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link rel="stylesheet" href="index.css">
+
+<h1>integraal</h1>
+
+<h2>scope of the project</h2>
+
+<p>
+    Integraal is a Rust crate that aims to provide generic and efficient tools for
+    <a href="https://en.wikipedia.org/wiki/Numerical_integration">numerical integration</a>
+    in the Rust Programming Language.
+</p><p>
+    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.
+</p><p>
+    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.
+</p>
+
+<h2>links</h2>
+
+<nav class="menu">
+    <ul>
+        <li><a href="integraal">Integraal Rust Doc</a></li>
+        <li><a href="https://en.wikipedia.org/wiki/Numerical_integration">Numerical Integration</a></li>
+    </ul>
+</nav>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		cp docs/index.html target/doc
		cp docs/index.css target/doc