Add changes for documentation webpage

DataResponsibly · Nov 30, 2023 · 6651455 · 6651455
1 parent 8f98893
commit 6651455
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 5 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,21 @@
+name: ci 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/api.md b/docs/api.md
@@ -6,9 +6,8 @@ Welcome to the documentation for SynRD's synthesizers! Below, you'll find inform
 
 Synthesizer's Configuration Notebook is a file that provides a comprehensive guide and examples on how to configure and initialize synthesizers within the SynRD library. It serves as a reference for users who want to customize the behavior of synthesizers based on their specific requirements.
 
-- [Link to Configuration Notebook](config_notebook.ipynb)
+- [Link to Configuration Notebook](notebooks/config_notebook.ipynb)
 
----
 
 ## Data Synthesizer Classes
 

diff --git a/docs/blog/index.md b/docs/blog/index.md
diff --git a/docs/findings.md b/docs/findings.md
@@ -1 +1,11 @@
-hello
+# Findings Overview
+
+The "Findings" section serves as a comprehensive collection of results and observations obtained through the synthesis and analysis of various publications. Findings encapsulate key insights, comparisons, and contrasts derived from the examination of different papers.
+
+## Explore Findings
+
+Explore the [**Findings webpage**](web/index.html){:target="_blank"} to delve into detailed results and observations.
+
+## Contributing a New Paper
+
+To contribute a new paper and discover the details on how to do so, refer to the [**How to Add a New Paper**](quickstart.md#how-to-add-a-new-paper) section in the Quickstart guide.
diff --git a/docs/config_notebook.ipynb → docs/notebooks/config_notebook.ipynb b/docs/config_notebook.ipynb → docs/notebooks/config_notebook.ipynb
diff --git a/web/.DS_Store → docs/web/.DS_Store b/web/.DS_Store → docs/web/.DS_Store
diff --git a/web/data.csv → docs/web/data.csv b/web/data.csv → docs/web/data.csv
diff --git a/web/formatted_data.json → docs/web/formatted_data.json b/web/formatted_data.json → docs/web/formatted_data.json
diff --git a/web/index.html → docs/web/index.html b/web/index.html → docs/web/index.html
diff --git a/web/preprocess.ipynb → docs/web/preprocess.ipynb b/web/preprocess.ipynb → docs/web/preprocess.ipynb
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -65,7 +65,12 @@ plugins:
       wikilinks: true
   - mkdocs-jupyter:
       execute: false
+      include_source: true
       include_requirejs: true
+  - ezlinks:
+        warn_ambiguities: true
+        wikilinks: true
+        reference_links: true
 
 markdown_extensions:
   - abbr