Rework documentation

Documentation HTML is no longer checked in but created as a Github artifact.
funkelab · Aug 30, 2023 · 764f45b · 764f45b
1 parent e8237a8
commit 764f45b
Show file tree

Hide file tree

Showing 198 changed files with 295 additions and 86,769 deletions.
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
@@ -0,0 +1,59 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: "3.11"
+          mamba-version: "*"
+          channels: conda-forge
+          channel-priority: true
+
+      - name: Install package and dependencies
+        run: |
+          pip install git+https://github.com/funkelab/funlib.learn.torch
+          python -m pip install -e .[docs]
+
+      - name: Build documentation
+        run: sphinx-build docs/source docs/build/html -W -b html
+
+      - name: Upload Pages Artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/build/html
+          retention-days: 90
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,7 @@ net_iter*
 .idea
 *.hdf
 *.h5
+docs/_build/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+sample_data.zarr
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_images/tutorial_batch_provider_10_0.png b/docs/_images/tutorial_batch_provider_10_0.png
diff --git a/docs/_images/tutorial_batch_provider_11_0.png b/docs/_images/tutorial_batch_provider_11_0.png
diff --git a/docs/_images/tutorial_batch_provider_1_0.png b/docs/_images/tutorial_batch_provider_1_0.png
diff --git a/docs/_images/tutorial_batch_provider_2_0.png b/docs/_images/tutorial_batch_provider_2_0.png
diff --git a/docs/_images/tutorial_batch_provider_4_1.png b/docs/_images/tutorial_batch_provider_4_1.png
diff --git a/docs/_images/tutorial_batch_provider_5_0.png b/docs/_images/tutorial_batch_provider_5_0.png
diff --git a/docs/_images/tutorial_batch_provider_6_0.png b/docs/_images/tutorial_batch_provider_6_0.png
diff --git a/docs/_images/tutorial_batch_provider_7_0.png b/docs/_images/tutorial_batch_provider_7_0.png
diff --git a/docs/_images/tutorial_batch_provider_8_0.png b/docs/_images/tutorial_batch_provider_8_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_10_0.png b/docs/_images/tutorial_simple_pipeline_10_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_11_0.png b/docs/_images/tutorial_simple_pipeline_11_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_12_0.png b/docs/_images/tutorial_simple_pipeline_12_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_13_0.png b/docs/_images/tutorial_simple_pipeline_13_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_14_0.png b/docs/_images/tutorial_simple_pipeline_14_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_15_0.png b/docs/_images/tutorial_simple_pipeline_15_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_16_0.png b/docs/_images/tutorial_simple_pipeline_16_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_17_0.png b/docs/_images/tutorial_simple_pipeline_17_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_18_0.png b/docs/_images/tutorial_simple_pipeline_18_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_1_0.png b/docs/_images/tutorial_simple_pipeline_1_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_20_0.png b/docs/_images/tutorial_simple_pipeline_20_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_21_0.png b/docs/_images/tutorial_simple_pipeline_21_0.png
diff --git a/docs/_images/tutorial_simple_pipeline_22_8.png b/docs/_images/tutorial_simple_pipeline_22_8.png
diff --git a/docs/_images/tutorial_simple_pipeline_22_9.png b/docs/_images/tutorial_simple_pipeline_22_9.png
diff --git a/docs/_images/tutorial_simple_pipeline_23_14.png b/docs/_images/tutorial_simple_pipeline_23_14.png
diff --git a/docs/_images/tutorial_simple_pipeline_5_1.png b/docs/_images/tutorial_simple_pipeline_5_1.png
diff --git a/docs/_images/tutorial_simple_pipeline_7_1.png b/docs/_images/tutorial_simple_pipeline_7_1.png
diff --git a/docs/_images/tutorial_simple_pipeline_9_0.png b/docs/_images/tutorial_simple_pipeline_9_0.png
diff --git a/docs/_modules/gunpowder/array.html b/docs/_modules/gunpowder/array.html
diff --git a/docs/_modules/gunpowder/array_spec.html b/docs/_modules/gunpowder/array_spec.html
diff --git a/docs/_modules/gunpowder/batch.html b/docs/_modules/gunpowder/batch.html
diff --git a/docs/_modules/gunpowder/batch_request.html b/docs/_modules/gunpowder/batch_request.html