Add Dependency Breadcrumbs (#13)

* add dependency breadcrumbs

* update .readthedocs.yml s.t. plamsapy_sphinx[docs] is used to install dependencies

* remove environment.yml

* clean format

.readthedocs.yml

@@ -18,6 +18,7 @@ sphinx:
 
 python:
   install:
-  - requirements: requirements/docs.txt
   - method: pip
     path: .
+    extra_requirements:
+    - docs

pyproject.toml

@@ -1,7 +1,9 @@
 [build-system]
-requires = ["setuptools >= 41.2",
-            "setuptools_scm",
-            "wheel >= 0.29.0"]  # ought to mirror 'requirements/build.txt'
+requires = [  # ought to mirror 'requirements/build.txt'
+    "setuptools >= 41.2",
+    "setuptools_scm",
+    "wheel >= 0.29.0",
+]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -31,7 +33,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-dependencies = [
+dependencies = [  # ought to mirror 'requirements/install.txt'
   "docutils",
   "importlib_metadata; python_version < '3.8'",
   "jinja2 != 3.1",
@@ -41,7 +43,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-tests = [
+tests = [  # ought to mirror 'requirements/tests.txt'
   "codespell",
   "dlint",
   "flake8",
@@ -59,7 +61,7 @@ tests = [
   "pytest-xdist",
   "tox",
 ]
-docs = [
+docs = [  # ought to mirror 'requirements/docs.txt'
     "numpydoc",
     "packaging",
     "pillow",

requirements.txt

@@ -1,8 +1,7 @@
 # all dependencies required to build, run, test, and document plasmapy_sphinx
 # * look to the specific requirements/*.txt for specific needs
-# * this will mimic `pip install plasmapy[developer]` (excluding plasmapy)
+#
 -r requirements/build.txt
 -r requirements/install.txt
 -r requirements/tests.txt
 -r requirements/docs.txt
--r requirements/extras.txt

requirements/build.txt

@@ -1,5 +1,8 @@
-# these are dependencies required to build the package distribution for installation
-# ought to mirror 'build-system.requires' under in pyproject.toml
+# these are dependencies required to build the package distribution for
+# installation
+#
+# ought to mirror [build-system.requires] under in pyproject.toml
+#
 setuptools >= 41.2
 setuptools_scm
 wheel >= 0.29.0

requirements/docs.txt

@@ -1,8 +1,7 @@
-# These are dependencies required to build package documentation, and
-# ought to mirror 'docs' under options.extras_require in setup.cfg.
-# This lists the requirements that would be installed when doing:
-# pip install plasmapy[docs]
--r extras.txt
+# These are dependencies required to build package documentation
+#
+# ought to mirror [project.optional-dependencies.docs] in pyproject.toml
+#
 -r install.txt
 numpydoc
 packaging

requirements/install.txt

@@ -1,5 +1,7 @@
 # these are dependencies required to use the package
-# ought to mirror 'install_requires' under 'options' in setup.cfg
+#
+# ought to mirror [project.dependencies] in pyproject.toml
+#
 -r build.txt
 docutils
 importlib_metadata; python_version < '3.8'

requirements/tests.txt

@@ -1,9 +1,9 @@
-# These are dependencies required to run package tests, and
-# ought to mirror 'tests' under options.extras_require in setup.cfg.
-# This lists the requirements that would be installed when doing:
-# pip install plasmapy[tests]
--r extras.txt
+# These are dependencies required to run package tests
+#
+# ought to mirror [project.optional-dependencies.tests] in pyproject.toml
+#
 -r install.txt
+codespell
 dlint
 flake8
 flake8-absolute-import
@@ -13,7 +13,9 @@ flake8-rst-docstrings
 flake8-simplify
 flake8-use-fstring
 hypothesis
+pre-commit
 pydocstyle
 pytest >= 5.4.0
 pytest-regressions
 pytest-xdist
+tox