Update docs.yml

.github/workflows/docs.yml

@@ -1,46 +1,42 @@
-name: docs
+# name: docs
 
 # build the documentation whenever there are new commits on main
-on:
-  push:
-    branches:
-      - main
-    # Alternative: only build for tags.
-    # tags:
-    #   - '*'
+# on:
+#   push:
+#     branches:
+#       - main
+#     # Alternative: only build for tags.
+#     # tags:
+#     #   - '*'
 
-# security: restrict permissions for CI jobs.
-permissions:
-  contents: read
+# permissions:
+#   contents: read
 
-jobs:
-  # Build the documentation and upload the static HTML files as an artifact.
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
+# jobs:
+#   build:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v4
+#       - uses: actions/setup-python@v5
+#         with:
+#           python-version: '3.12'
 
-      - run: pip install -e '.[docs]'
-      - run: DOC_ALLOW_EXEC=1 pdoc --docformat google -o docs/ snputils
+#       - run: pip install -e '.[docs]'
+#       - run: DOC_ALLOW_EXEC=1 pdoc --docformat google -o docs/ snputils
 
-      - uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/
+#       - uses: actions/upload-pages-artifact@v3
+#         with:
+#           path: docs/
 
-  # 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
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - id: deployment
-        uses: actions/deploy-pages@v4
+#   deploy:
+#     needs: build
+#     runs-on: ubuntu-latest
+#     permissions:
+#       pages: write
+#       id-token: write
+#     environment:
+#       name: github-pages
+#       url: ${{ steps.deployment.outputs.page_url }}
+#     steps:
+#       - id: deployment
+#         uses: actions/deploy-pages@v4