Add GitHub Actions

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+### Bug Description
+Please provide a detailed description of the issue you encountered.
+
+### Steps to Reproduce
+1. Step 1
+2. Step 2
+3. ...
+
+### Expected Behavior
+Describe what you expected to happen.
+
+### Actual Behavior
+Describe what actually happened.
+
+### Environment Information
+- Operating System: [e.g., Ubuntu 20.04]
+- Python Version: [e.g., 3.10.12]
+- Installation Method: [e.g., pypi, source]
+- Trinity-RFT Version: [e.g., 0.1.0]
+- Other relevant dependencies or configurations
+
+### Log Information
+If applicable, include any relevant log output here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,11 @@
+### Feature Request
+Please provide a detailed description of the feature you would like to see added.
+
+### Purpose of the Feature
+Explain the purpose of the feature and how it will help the project or users.
+
+### Expected Implementation (Optional)
+If you have specific ideas, please describe how you expect this feature to be implemented.
+
+### Additional Information
+Provide any other information that might be helpful for us to understand this feature request.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Description
+
+[Please describe the background, purpose, changes made, and how to test this PR]
+
+
+## Checklist
+
+Please check the following items before code is ready to be reviewed.
+
+- [ ]  Code has passed all tests
+- [ ]  Docstrings have been added/updated in Google Style
+- [ ]  Documentation has been updated
+- [ ]  Code is ready for review

.github/workflows/pre-commit.yaml

@@ -0,0 +1,13 @@
+name: pre-commit
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - uses: pre-commit/[email protected]

.github/workflows/sphinx-doc.yaml

@@ -0,0 +1,46 @@
+name: Deploy Sphinx Doc to Pages
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths:
+      - 'docs/sphinx_doc/**/*'
+  push:
+    branches:
+      - main
+
+jobs:
+  pages:
+    timeout-minutes: 20
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.10']
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: '3.10'
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        pip install -q -e .[doc]
+    - id: build
+      name: Build Documentation
+      run: |
+        cd docs/sphinx_doc
+        ./build_doc.sh
+    - name: Upload Documentation
+      uses: actions/upload-artifact@v4
+      with:
+        name: SphinxDoc
+        path: 'docs/sphinx_doc/build'
+    - uses: peaceiris/actions-gh-pages@v3
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: 'docs/sphinx_doc/build/html'

docs/sphinx_doc/source/conf.py

@@ -48,7 +48,7 @@
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 html_theme_options = {
-    "navigation_depth": 2,
+    "navigation_depth": 3,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,