Merge pull request #5 from AlexanderFengler/add_docstrings

Add docstrings
AlexanderFengler · Sep 17, 2023 · 92c8d0c · 92c8d0c
2 parents 5f5415e + 4289e80
commit 92c8d0c
Show file tree

Hide file tree

Showing 20 changed files with 838 additions and 55 deletions.
diff --git a/.github/workflows/build_wheels.yml b/.github/workflows/build_wheels.yml
@@ -11,28 +11,28 @@ on:
       - published
 
 jobs:
-  build_wheels:
-    name: Build wheels on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-22.04, windows-2022, macos-11]
+  # build_wheels:
+  #   name: Build wheels on ${{ matrix.os }}
+  #   runs-on: ${{ matrix.os }}
+  #   strategy:
+  #     matrix:
+  #       os: [ubuntu-22.04, windows-2022, macos-11]
 
-    steps:
-      - uses: actions/checkout@v4
+  #   steps:
+  #     - uses: actions/checkout@v4
 
-      - name: Build wheels
-        uses: pypa/cibuildwheel@v2.15.0
-        env:
-          CIBW_BUILD: cp39-* cp310-*
-          CIBW_ARCHS_MACOS: "x86_64 universal2 arm64"
-          CIBW_ARCHS_LINUX: auto64
-          CIBW_ARCHS_WINDOWS: auto64
-          CIBW_BUILD_FRONTEND: build
+  #     - name: Build wheels
+  #       uses: pypa/cibuildwheel@v2.15.0
+  #       env:
+  #         CIBW_BUILD: cp39-* cp310-*
+  #         CIBW_ARCHS_MACOS: "x86_64 universal2 arm64"
+  #         CIBW_ARCHS_LINUX: auto64
+  #         CIBW_ARCHS_WINDOWS: auto64
+  #         CIBW_BUILD_FRONTEND: build
 
-      - uses: actions/upload-artifact@v3
-        with:
-          path: ./wheelhouse/*.whl
+  #     - uses: actions/upload-artifact@v3
+  #       with:
+  #         path: ./wheelhouse/*.whl
 
   build_sdist:
     name: Build source distribution
@@ -48,7 +48,7 @@ jobs:
           path: dist/*.tar.gz
 
   upload_test_pypi:
-    needs: [build_wheels, build_sdist]
+    needs: [build_sdist] #[build_wheels, build_sdist]
     runs-on: ubuntu-latest
     if: github.event_name == 'release' && github.event.action == 'published'
     # or, alternatively, upload to PyPI on every tag starting with 'v' (remove on: release above to use this)
@@ -67,7 +67,7 @@ jobs:
           repository-url: https://test.pypi.org/legacy/
 
   upload_pypi:
-    needs: [build_wheels, build_sdist, upload_test_pypi]
+    needs: [build_sdist, upload_test_pypi] #[build_wheels, build_sdist, upload_test_pypi]
     runs-on: ubuntu-latest
     # Add these back after setting up trusted publishing
     # environment: pypi

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,4 @@
+recursive-include docs
 include README.md LICENSE
 include lanfactory *.py
 include notebooks/*

diff --git a/README.md b/README.md
@@ -1,7 +1,15 @@
 # LANfactory
 
+![PyPI](https://img.shields.io/pypi/v/lanfactory)
+![PyPI_dl](https://img.shields.io/pypi/dm/lanfactory)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
 Lightweight python package to help with training [LANs](https://elifesciences.org/articles/65074) (Likelihood approximation networks). 
 
+Please find the original [documentation here](https://alexanderfengler.github.io/LANfactory/).
+
 ### Quick Start
 
 The `LANfactory` package is a light-weight convenience package for training `likelihood approximation networks` (LANs) in torch (or keras), 

diff --git a/docs/api/config.md b/docs/api/config.md
@@ -0,0 +1 @@
+:::lanfactory.config
diff --git a/docs/api/lanfactory.md b/docs/api/lanfactory.md
@@ -0,0 +1 @@
+:::lanfactory
diff --git a/docs/api/onnx.md b/docs/api/onnx.md
@@ -0,0 +1 @@
+:::lanfactory.onnx
diff --git a/docs/api/trainers.md b/docs/api/trainers.md
@@ -0,0 +1 @@
+:::lanfactory.trainers
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -0,0 +1 @@
+:::lanfactory.utils
diff --git a/notebooks/basic_tutorial.ipynb → docs/basic_tutorial/basic_tutorial.ipynb b/notebooks/basic_tutorial.ipynb → docs/basic_tutorial/basic_tutorial.ipynb