Fix doc warning

sunpy · Nov 17, 2023 · 816c744 · 816c744
1 parent 3958ce3
commit 816c744
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 55 deletions.
diff --git a/.github/workflows/dependabot.yml → .github/dependabot.yml b/.github/workflows/dependabot.yml → .github/dependabot.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -95,9 +95,10 @@ jobs:
           lfs: true
       - uses: conda-incubator/setup-miniconda@v2
         with:
+          installer-url: https://github.com/conda-forge/miniforge/releases/download/4.8.3-2/Miniforge-pypy3-4.8.3-2-Linux-x86_64.sh
+          python-version: 3.11
           activate-environment: sunkit_image_test
           environment-file: sunkit-dev-env.yml
-          python-version: 3.11
       - name: Install sunkit_image
         shell: bash -el {0}
         run: |

diff --git a/pyproject.toml b/pyproject.toml
@@ -23,70 +23,69 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 target-version = "py39"
 line-length = 120
 exclude=[
-    ".git,",
-    "__pycache__",
-    "build",
-    "tools/**",
+  ".git,",
+  "__pycache__",
+  "build",
+  "tools/**",
 ]
 select = [
-       "E",
-       "F",
-       "W",
-       "UP",
-       "PT",
-       "RET",
-       "TID",
-       "PLE",
-       "NPY",
-       "RUF",
-       "PGH",
-       "PTH",
-       "BLE",
-       "FBT",
-       "B",
-       "A",
-       "COM",
-       "C4",
-       "T20",
-       "RSE",
-       "ERA",
+  "E",
+  "F",
+  "W",
+  "UP",
+  "PT",
+  "RET",
+  "TID",
+  "PLE",
+  "NPY",
+  "RUF",
+  "PGH",
+  "PTH",
+  "BLE",
+  "FBT",
+  "B",
+  "A",
+  "COM",
+  "C4",
+  "T20",
+  "RSE",
+  "ERA",
 ]
 fixable = [
-       "E",
-       "F",
-       "W",
-       "UP",
-       "PT",
-       "RET",
-       "TID",
-       "PLE",
-       "NPY",
-       "RUF",
-       "PGH",
-       "PTH",
-       "BLE",
-       "FBT",
-       "B",
-       "A",
-       "COM",
-       "C4",
-       "T20",
-       "RSE",
-       "ERA",
+  "E",
+  "F",
+  "W",
+  "UP",
+  "PT",
+  "RET",
+  "TID",
+  "PLE",
+  "NPY",
+  "RUF",
+  "PGH",
+  "PTH",
+  "BLE",
+  "FBT",
+  "B",
+  "A",
+  "COM",
+  "C4",
+  "T20",
+  "RSE",
+  "ERA",
 ]
 extend-ignore = [
-    "E501",  # Line too long
-    # TODO: Fix in future
-    "E741",  # Ambiguous variable name
-    "B006",  # Do not use mutable data structures for argument defaults
-    "FBT002",  # Boolean default value in function definition
-
+  "E501",  # Line too long
+  # TODO: Fix in future
+  "E741",  # Ambiguous variable name
+  "B006",  # Do not use mutable data structures for argument defaults
+  "FBT002",  # Boolean default value in function definition
 ]
 
 [tool.ruff.per-file-ignores]
 "examples/*.py" = [
-    "T201", # We need print in our examples
-    "PGH004", # Sometimes we need to use NOQA in examples
+  "T201", # We need print in our examples
+  "PGH004", # Sometimes we need to use NOQA in examples
 ]
 
 [tool.ruff.pydocstyle]

diff --git a/setup.cfg b/setup.cfg
@@ -50,6 +50,8 @@ docs =
   beautifulsoup4
   dask
   drms
+  # Remove next line when fixed in towncrier; see https://github.com/twisted/towncrier/issues/528
+  importlib-resources<6
   matplotlib
   sphinx
   sphinx_automodapi