From 3773c45e134a39813349ff4c63e9a190d5c93c18 Mon Sep 17 00:00:00 2001 From: Ian Kenney Date: Tue, 7 Nov 2023 15:12:42 -0700 Subject: [PATCH] Fixed links --- docs/source/makingakit.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/makingakit.rst b/docs/source/makingakit.rst index aa557f7d..0ce22fc4 100644 --- a/docs/source/makingakit.rst +++ b/docs/source/makingakit.rst @@ -3,7 +3,7 @@ Making an MDAKit **************** Here, we outline the process of creating an MDAKit that fulfills all of the requirements for acceptance into the MDAKit registry. -For a video walk-through of this tutorial, watch `our recorded :ref:`tutorial` on YouTube. +For a video walk-through of this tutorial, watch `our recorded tutorial `_ on YouTube. Unlike the code in the core MDAnalysis library, the structure of an MDAKit is much less restrictive. In order to be accepted, there are several :ref:`requirements` that must be addressed: @@ -589,7 +589,7 @@ These tests are to signify to the users of your packages that the code performs Basic tests can be written with a variety of packages, such as the `unittest package `_ or the `pytest package `_. Futher improvements to your testing proceedure may include automatically running the tests on pushing to your remote repositories (see `GitHub Actions `_). -When submitting an MDAKit to the registry, you can include the instructions for running the tests in the required ``metadata.yaml`` file (see a full example in the "Registering a Kit" section below). +When submitting an MDAKit to the registry, you can include the instructions for running the tests in the required ``metadata.yaml`` file (see a full example in the `registration `_ section below). Assuming that your tests are in a ``test/`` directory at the top level of your repository, you could define your test commands as: .. code-block:: yaml @@ -610,6 +610,8 @@ This is reflected in your MDAKit metadata with test_dependencies: - mamba install pytest MDAnalysis +.. _registration: + Registering an MDAKit #####################