Streamlined docs.

aidos-lab · Jul 2, 2024 · 9a397c4 · 9a397c4
1 parent 5925185
commit 9a397c4
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 2,315 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -37,7 +37,9 @@ jobs:
       # ADJUST THIS: build your documentation into docs/.
       # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
       - name: Build Docs
-        run: python -m pdoc --docformat numpy --logo "https://avatars.githubusercontent.com/u/88346553?s=200&v=4" dect -o ./docs
+        run: |
+          mkdir -p ./docs
+          python -m pdoc --docformat numpy --logo "https://avatars.githubusercontent.com/u/88346553?s=200&v=4" dect -o ./docs
 
       - uses: actions/upload-pages-artifact@v3
         with:

diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ of a vector given an index vector.
 
 For example usage, we provide the `notebooks/example.ipynb` file and the code therein reproduces the 
 ECT of the gif of this readme. 
-The code is provided on an as-is basis; see [LICENSE.md](LICENSE.md) for more information.
+The code is provided on an as-is basis; see [LICENSE.md](https://github.com/aidos-lab/dect/blob/main/LICENSE.md) for more information.
 You are cordially invited to both contribute and provide feedback. Do not hesitate to contact us!
 
 ```python

diff --git a/docs/dect.html b/docs/dect.html
diff --git a/docs/dect/directions.html b/docs/dect/directions.html
diff --git a/docs/dect/ect.html b/docs/dect/ect.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/search.js b/docs/search.js