add documentation.yml file

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: Generate Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        pip install pydoc
+
+    - name: Generate HTML Documentation
+      run: |
+        mkdir -p docs
+        pydoc -w optimizer
+        mv optimizer.html docs/index.html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs

src/optimizer.py

@@ -1,3 +1,6 @@
+# ------ Optimizer for cga, sync_ga, alpha_cga, ccga and mcccga methods ------ #
+
+
 # ------------------------------ selection --------------------------------- #
 from selection.roulette_wheel_selection import RouletteWheelSelection
 from selection.tournament_selection import TournamentSelection