Inductance (#19)

* update pypi workflow * update pypi workflow * add autosummary
dgarnier · Jun 30, 2023 · bafcf23 · bafcf23
1 parent 234e1e4
commit bafcf23
Show file tree

Hide file tree

Showing 11 changed files with 818 additions and 219 deletions.
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - master
 
 jobs:
   labeler:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -10,6 +10,12 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/inductance
+    permissions:
+      id-token: write
+
     steps:
       - name: Check out the repository
         uses: actions/checkout@v3
@@ -57,17 +63,12 @@ jobs:
 
       - name: Publish package on PyPI
         if: steps.check-version.outputs.tag
-        uses: pypa/[email protected]
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}
+        uses: pypa/[email protected]
 
       - name: Publish package on TestPyPI
         if: "! steps.check-version.outputs.tag"
-        uses: pypa/gh-action-pypi-publish@v1.6.4
+        uses: pypa/gh-action-pypi-publish@v1.8.7
         with:
-          user: __token__
-          password: ${{ secrets.TEST_PYPI_TOKEN }}
           repository_url: https://test.pypi.org/legacy/
 
       - name: Publish the release notes

diff --git a/docs/conf.py b/docs/conf.py
@@ -4,8 +4,8 @@
 copyright = "2023, Darren Garnier"
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
-    "sphinx_click",
     "myst_parser",
 ]
 autodoc_typehints = "description"

diff --git a/docs/index.md b/docs/index.md
@@ -11,10 +11,9 @@ end-before: <!-- github-only -->
 ```{toctree}
 ---
 hidden:
-maxdepth: 1
+maxdepth: 2
 ---
 
-usage
 reference
 contributing
 Code of Conduct <codeofconduct>

diff --git a/docs/reference.md b/docs/reference.md
@@ -3,6 +3,9 @@
 ## inductance
 
 ```{eval-rst}
+.. autosummary::
+   :toctree: generated
+
 .. automodule:: inductance
    :members:
 ```
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,3 @@
 furo==2022.12.7
 sphinx==5.3.0
-sphinx-click==4.4.0
 myst_parser==0.18.1
diff --git a/docs/usage.md b/docs/usage.md
@@ -1,7 +1,5 @@
 # Usage
 
 ```{eval-rst}
-.. click:: pysol.__main__:main
-    :prog: pysol
-    :nested: full
+
 ```
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,6 @@ repository = "https://github.com/dgarnier/inductance"
 python = "^3.8"
 numpy = "^1.24"
 numba = "^0.57"
-click = "^8.0"
 
 [tool.poetry.dev-dependencies]
 poetry = "^1.4.0"

diff --git a/src/inductance/__main__.py b/src/inductance/__main__.py
diff --git a/tests/test_main.py b/tests/test_main.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ on: @@
       push:
         branches:
           - main
-          - master
     jobs:
       labeler:
@@ Expand Down @@