sphinx replaced with pdoc3

Signed-off-by: Berkay Bozkurt <[email protected]>

.github/workflows/documentation.yml

@@ -16,21 +16,24 @@ jobs:
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
-      - name: Sphinx build
+          python -m pip install --upgrade pip
+          pip install pipenv
+          # if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pipenv install --dev
+      - name: Set PYTHONPATH
         run: |
-          sphinx-apidoc -o docs src/
-      - name: Generate HTML
+          echo "PYTHONPATH=${PYTHONPATH}:${GITHUB_WORKSPACE}" >> $GITHUB_ENV
+      - name: Run Command
         run: |
-          cd docs
-          make clean html
-          make html
-          cd ..
+          echo $PYTHONPATH
+      - name: Generate pdoc
+        run: |
+          pdoc --html ./src --output-dir ../docs
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/python-generation' }}
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_build/html/
+          publish_dir: docs/src/
           force_orphan: true

.gitignore

@@ -57,19 +57,7 @@ bin/
 **/data/classification_reports/*
 
 #generated pydoc
-**/docs/_build/*
-**/docs/_static/*
-**/docs/_templates/*
-**/docs/*.html
-**/docs/*.js
-**/docs/*.rst
-
-!**/docs/.gitkeep
-!**/docs/.conf.py
-!**/docs/Makefile
-!**/docs/make.bat
-!**/docs/index.rst
-
+/docs/*
 
 # Env files
 *.env

Pipfile

@@ -52,6 +52,7 @@ colorama = "*"
 torch = "2.1.2"
 deutschland = "0.4.0"
 bs4 = "0.0.2"
+pdoc3 = "0.10.0"
 
 [requires]
 python_version = "3.10"