Cleanup ci job

fishjam-dev · Sep 15, 2023 · 5ab28fc · 5ab28fc
1 parent c43702c
commit 5ab28fc
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 3,328 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,10 +5,6 @@ on:
     branches:
       - impove-readme
 
-# security: restrict permissions for CI jobs.
-permissions:
-  contents: read
-
 jobs:
   # Build the documentation and upload the static HTML files as an artifact.
   build:
@@ -18,18 +14,13 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.8'
-
       - run: pip install -r dev-requirements.txt
-      # ADJUST THIS: build your documentation into docs/.
-      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
       - run: pdoc -o doc jellyfish
-
       - uses: actions/upload-pages-artifact@v2
         with:
           path: doc
 
   # Deploy the artifact to GitHub pages.
-  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
   deploy:
     needs: build
     runs-on: ubuntu-latest

diff --git a/.gitignore b/.gitignore
@@ -68,8 +68,8 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
+# pdoc documentation
+/doc
 
 # PyBuilder
 .pybuilder/

diff --git a/doc/index.html b/doc/index.html