Skip to content

Commit 46734e9

Browse files
authored
update makingakit.rst (#144)
- remove setup.py edits (we don't create setup.py) - add line to activate rmsfkit environment
1 parent 9159811 commit 46734e9

File tree

1 file changed

+2
-17
lines changed

1 file changed

+2
-17
lines changed

docs/source/makingakit.rst

+2-17
Original file line numberDiff line numberDiff line change
@@ -260,22 +260,6 @@ file. Under the ``[project.optional-dependencies]`` table, ensure that
260260
"MDAnalysisTests>=2.0.0",
261261
]
262262
263-
These tests also need to be reflected in the ``extra_requires`` dictionary in ``setup.py``:
264-
265-
.. code-block:: python
266-
267-
extras_require={
268-
"test": [
269-
"pytest>=6.0",
270-
"pytest-xdist>=2.5",
271-
"pytest-cov>=3.0",
272-
"MDAnalysisTests>=2.0.0" # add this
273-
],
274-
"doc": [
275-
"sphinx",
276-
"sphinx_rtd_theme",
277-
]
278-
}
279263
280264
Confirm that the code and tests work
281265
************************************
@@ -288,6 +272,7 @@ environment using ``conda`` or ``mamba`` (recommended).
288272
289273
$ mamba create -n rmsfkit
290274
$ mamba env update --name rmsfkit --file devtools/conda-envs/test_env.yaml
275+
$ mamba activate rmsfkit
291276
$ pip install -e .
292277
293278
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
696681
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.
697682
The issue will automatically close after the next CI run if the tests pass again.
698683

699-
.. _read the docs: https://readthedocs.org
684+
.. _read the docs: https://readthedocs.org

0 commit comments

Comments
 (0)