Skip to content

Commit

Permalink
update makingakit.rst (#144)
Browse files Browse the repository at this point in the history
- remove setup.py edits (we don't create setup.py)
- add line to activate rmsfkit environment
  • Loading branch information
orbeckst authored May 24, 2024
1 parent 9159811 commit 46734e9
Showing 1 changed file with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions docs/source/makingakit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
************************************
Expand All @@ -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:
Expand Down Expand Up @@ -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
.. _read the docs: https://readthedocs.org

0 comments on commit 46734e9

Please sign in to comment.