revert template changes

.ruff.toml

@@ -12,7 +12,7 @@ exclude = [
 select = ["E", "F", "W", "UP", "PT"]
 extend-ignore = [
   # pycodestyle (E, W)
-  "E501", # LineTooLong
+  "E501", # LineTooLong                             # TODO! fix
   # pytest (PT)
   "PT001", # Always use pytest.fixture()
   "PT004", # Fixtures which don't return anything should have leading _

docs/conf.py

@@ -51,6 +51,9 @@
 # The master toctree document.
 master_doc = "index"
 
+# Treat everything in single ` as a Python reference.
+default_role = 'py:obj'
+
 # -- Options for intersphinx extension ---------------------------------------
 
 intersphinx_mapping = {
@@ -99,6 +102,5 @@
 # See https://github.com/sunpy/sunpy/wiki/Home:-JSOC
 os.environ["JSOC_EMAIL"] = '[email protected]'
 
-default_role = 'py:obj'
 nitpicky = True
 numfig = True

pyproject.toml

@@ -10,7 +10,7 @@ name = "sunkit_magex"
 description = "Solar Magnetic field Extrapollation"
 requires-python = ">=3.10"
 readme = { file = "README.rst", content-type = "text/x-rst" }
-license = { file = "licenses/LICENSE.rst"}
+license = { file = "licenses/LICENSE.rst", content-type = "text/plain"}
 authors = [
   { name = "The SunPy Community", email = "[email protected]" },
 ]

sunkit_magex/tests/__init__.py

@@ -0,0 +1,4 @@
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+"""
+This module contains package tests.
+"""

tox.ini

@@ -11,20 +11,22 @@ envlist =
 
 [testenv]
 pypi_filter = https://raw.githubusercontent.com/sunpy/sunpy/main/.test_package_pins.txt
-# Run the tests in a temporary directory to make sure that we don't import the package from the source tree
-# This is only needed if you do not use a src directory like a sane person
+# Run the tests in a temporary directory to make sure that we don't import
+# the package from the source tree
 change_dir = .tmp/{envname}
 description =
     run tests
     oldestdeps: with the oldest supported version of key dependencies
     devdeps: with the latest developer version of key dependencies
+
 pass_env =
     # Custom compiler locations (such as ccache)
     CC
     # Location of locales (needed by sphinx on some systems)
     LOCALE_ARCHIVE
     # If the user has set a LC override we should follow it
     LC_ALL
+
 set_env =
     MPLBACKEND=agg
     devdeps: PIP_EXTRA_INDEX_URL = https://pypi.anaconda.org/astropy/simple https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
@@ -38,13 +40,22 @@ deps =
     # devdeps: git+https://github.com/ndcube/ndcube
     oldestdeps: minimum_dependencies
     pytest-xdist
+
+# The following indicates which extras_require will be installed
 extras =
     tests
+
 commands_pre =
     oldestdeps: minimum_dependencies sunkit_magex --filename requirements-min.txt
     oldestdeps: pip install -r requirements-min.txt
     pip freeze --all --no-input
+
 commands =
+    # To run different commands for different factors exclude the factor from the default command like this
+    # !online: {env:PYTEST_COMMAND} {posargs}
+    # Then specify a specific one like this
+    # online: {env:PYTEST_COMMAND} --remote-data=any {posargs}
+    # If you have no factors which require different commands this is all you need:
     {env:PYTEST_COMMAND} {posargs}
 
 [testenv:codestyle]