Update Sphinx configuration and documentation structure

GoMightyAlgorythmGo · Jun 5, 2024 · 5bc3651 · 5bc3651
1 parent 53de091
commit 5bc3651
Show file tree

Hide file tree

Showing 12 changed files with 152 additions and 11 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,36 @@
+name: Generate Changelog
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [closed]
+
+jobs:
+  generate-changelog:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14'
+
+    - name: Install auto-changelog
+      run: npm install -g auto-changelog
+
+    - name: Generate changelog
+      run: auto-changelog -p
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Commit and push changelog
+      run: |
+        git config --global user.name 'github-actions[bot]'
+        git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+        git add CHANGELOG.md
+        git commit -m 'Update changelog'
+        git push
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,32 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx sphinx_rtd_theme
+
+    - name: Build documentation
+      run: sphinx-build -b html docs/ docs/_build/html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html
diff --git a/.github/workflows/repo-maintenance.yml b/.github/workflows/repo-maintenance.yml
@@ -39,9 +39,9 @@ jobs:
 
       - name: Use BFG Repo-Cleaner
         run: |
-          java -jar /path/to/bfg.jar --strip-blobs-bigger-than 100M .
-          java -jar /path/to/bfg.jar --delete-files '0cdcac6eb1aa268b98e2cc30f80a183e2bc81dba' .
-          java -jar /path/to/bfg.jar --delete-files '5b44edb4c90a21f3f2ccc3f50411ac1825f8cc0b' .
+          java -jar ${{ github.workspace }}/bfg.jar --strip-blobs-bigger-than 100M .
+          java -jar ${{ github.workspace }}/bfg.jar --delete-files '0cdcac6eb1aa268b98e2cc30f80a183e2bc81dba' .
+          java -jar ${{ github.workspace }}/bfg.jar --delete-files '5b44edb4c90a21f3f2ccc3f50411ac1825f8cc0b' .
 
       - name: Clean up repository
         run: |

diff --git a/README.md b/README.md
@@ -94,3 +94,66 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 - Monitor and address any issues in GitHub Actions.
 - Continue developing and refining the model.
 - Regularly update documentation.
+
+
+Updated on: 2024-06-03 16:28:58
+
+
+Updated on: 2024-06-03 16:31:44
+
+
+Updated on: 2024-06-04 07:53:35
+
+
+Updated on: 2024-06-04 07:56:09
+
+
+Updated on: 2024-06-04 07:59:17
+
+
+Updated on: 2024-06-04 07:59:31
+
+
+Updated on: 2024-06-04 08:04:11
+
+
+Updated on: 2024-06-05 00:02:01
+
+
+Updated on: 2024-06-05 00:07:20
+
+
+Updated on: 2024-06-05 00:12:53
+
+
+Updated on: 2024-06-05 00:20:27
+
+
+Updated on: 2024-06-05 00:24:24
+
+
+Updated on: 2024-06-05 00:25:37
+
+
+Updated on: 2024-06-05 00:28:56
+
+
+Updated on: 2024-06-05 00:37:46
+
+
+Updated on: 2024-06-05 00:38:21
+
+
+Updated on: 2024-06-05 00:39:36
+
+
+Updated on: 2024-06-05 00:40:42
+
+
+Updated on: 2024-06-05 00:41:55
+
+
+Updated on: 2024-06-05 08:51:19
+
+
+Updated on: 2024-06-05 09:06:02
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/execution_log.txt b/execution_log.txt
diff --git a/my_project b/my_project
diff --git a/pj_log_15_5_24____.txt b/pj_log_15_5_24____.txt
diff --git a/remove_bom.py b/remove_bom.py
@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+with open('notebooks/model_building.ipynb', 'r', encoding='utf-8-sig') as file:
+    content = file.read()
+with open('notebooks/model_building.ipynb', 'w', encoding='utf-8') as file:
+    file.write(content)
diff --git a/scripts/verify_trello.py b/scripts/verify_trello.py
@@ -2,19 +2,19 @@
 import requests
 import os
 
-TRELLO_API_KEY = os.getenv("TRELLO_API_KEY")
-TRELLO_API_TOKEN = os.getenv("TRELLO_API_TOKEN")
+TRELLO_API_KEY = os.getenv('TRELLO_API_KEY')
+TRELLO_API_TOKEN = os.getenv('TRELLO_API_TOKEN')
 
 def verify_trello_credentials():
-    url = f"https://api.trello.com/1/members/me/boards?key={TRELLO_API_KEY}&token={TRELLO_API_TOKEN}"
+    url = f'https://api.trello.com/1/members/me/boards?key={TRELLO_API_KEY}&token={TRELLO_API_TOKEN}'
     response = requests.get(url)
     if response.status_code == 200:
-        print("Success!")
+        print('Success!')
         print(response.json())
     else:
-        print("Failed to verify credentials")
-        print(f"Status Code: {response.status_code}")
-        print(f"Response Text: {response.text}")
+        print('Failed to verify credentials')
+        print(f'Status Code: {response.status_code}')
+        print(f'Response Text: {response.text}')
 
 if __name__ == "__main__":
     verify_trello_credentials()