diff --git a/docs/requirements.yaml b/docs/requirements.yaml index a3604287..d28ca113 100644 --- a/docs/requirements.yaml +++ b/docs/requirements.yaml @@ -9,6 +9,7 @@ dependencies: - sphinx - mdanalysis-sphinx-theme + - sphinxcontrib-youtube - pyyaml - pydantic diff --git a/docs/source/about.rst b/docs/source/about.rst index db5dc7c2..c6202305 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -1,5 +1,7 @@ .. -*- coding: utf-8 -*- +.. _about-mdakits: + ************* About MDAKits ************* @@ -27,7 +29,7 @@ requirements**: #. Minimal documentation is provided (what your code does, how to install it, and how to use it) #. At least minimal regression tests are present; continuous integration is encouraged -#. The code is installable as a standard package +#. The source code is installable as a standard package It is also highly encouraged that the MDAKit also satisfies: diff --git a/docs/source/add.rst b/docs/source/add.rst deleted file mode 100644 index df87a75d..00000000 --- a/docs/source/add.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. _add-mdakit: - -******************************** -Adding an MDAKit to the Registry -******************************** - -Do you have an MDAKit? Consider adding it to the `MDAKit registry`_! - - -.. note:: - The `MDAKit registry`_ is still in its initial stages. We expect that the way in - which MDAKits are added, and the type of information required, may change - over time. Please reach out via the `issue tracker`_ if you have any - questions. - -Registering an MDAKit requires you to create a single file with metadata -(called ``metadata.yaml``). You add this file to the `MDAnalysis/mdakits -repository`_ on GitHub. - -Process -======= - -Add a MDAKit by following these steps: - -#. Create a fork of the MDAKit repository https://github.com/MDAnalysis/mdakits. -#. Make a new branch (choose any name, but "add-my-awesome-mdakit" is a good - one). -#. Add a new folder under ``mdakits`` with the name of your MDAKit. Please note that this *must* match the name provided under the `project_name` entry of the ``metadata.yaml`` file. -#. Add a metadata YAML file with your MDAKit's details; copy the template from - `mdakits/template/metadata.yaml`_ and modify it. See the comments in the - file and the :ref:`notes below