From 38bacf21f87c4662f197ce662b0080b6ceea5e68 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Thu, 23 May 2024 15:11:56 -0700 Subject: [PATCH] update makingakit.rst - remove setup.py edits (we don't create setup.py) - add line to activate rmsfkit environment --- docs/source/makingakit.rst | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/source/makingakit.rst b/docs/source/makingakit.rst index 45f97f89..5cdadb34 100644 --- a/docs/source/makingakit.rst +++ b/docs/source/makingakit.rst @@ -260,22 +260,6 @@ file. Under the ``[project.optional-dependencies]`` table, ensure that "MDAnalysisTests>=2.0.0", ] -These tests also need to be reflected in the ``extra_requires`` dictionary in ``setup.py``: - -.. code-block:: python - - extras_require={ - "test": [ - "pytest>=6.0", - "pytest-xdist>=2.5", - "pytest-cov>=3.0", - "MDAnalysisTests>=2.0.0" # add this - ], - "doc": [ - "sphinx", - "sphinx_rtd_theme", - ] - } Confirm that the code and tests work ************************************ @@ -288,6 +272,7 @@ environment using ``conda`` or ``mamba`` (recommended). $ mamba create -n rmsfkit $ mamba env update --name rmsfkit --file devtools/conda-envs/test_env.yaml + $ mamba activate rmsfkit $ pip install -e . This installs the package as well as the testing environment. We can run tests locally using: @@ -696,4 +681,4 @@ In the event that a kit no longer passes its tests, an issue in MDAnalysis/MDAKi While the registry developers will be happy to help where possible, ultimately, the maintainers of the MDAKit are responsible for resolving such issues and ensuring that the tests pass. The issue will automatically close after the next CI run if the tests pass again. -.. _read the docs: https://readthedocs.org \ No newline at end of file +.. _read the docs: https://readthedocs.org