Skip to content

Commit

Permalink
deploy: 924672f
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jul 28, 2023
1 parent f1311b9 commit 6188a57
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
Binary file modified .doctrees/add.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
8 changes: 5 additions & 3 deletions _sources/add.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
Adding an MDAKit to the Registry
********************************

Do you have an MDAKit? Consider adding it to the Registry!
Do you have an MDAKit? Consider adding it to the `MDAKit registry`_!


.. note::
The MDAKit registry is still in its infancy, we expect that the
The `MDAKit registry`_ is still in its infancy, 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.


Adding an MDAKit is a simple process, and follows the following steps:
* Create a fork the MDAKit repository
* Create a fork the MDAKit repository https://github.com/MDAnalysis/mdakits
* Make a new branch
* Add a new folder under ``mdakits`` with the name of your MDAKit
* Add a metadata YAML file with your MDAKit's details (a template can be found under ``mdakits/template``)
Expand Down Expand Up @@ -92,3 +92,5 @@ The following is an example metadata file for propkatraj::
.. _`issue tracker`:
https://github.com/MDAnalysis/MDAKits/issues

.. _`MDAKit registry`: https://mdakits.mdanalysis.org/mdakits.html

6 changes: 3 additions & 3 deletions add.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@

<section id="adding-an-mdakit-to-the-registry">
<h1>Adding an MDAKit to the Registry<a class="headerlink" href="#adding-an-mdakit-to-the-registry" title="Permalink to this heading"></a></h1>
<p>Do you have an MDAKit? Consider adding it to the Registry!</p>
<p>Do you have an MDAKit? Consider adding it to the <a class="reference external" href="https://mdakits.mdanalysis.org/mdakits.html">MDAKit registry</a>!</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The MDAKit registry is still in its infancy, we expect that the
<p>The <a class="reference external" href="https://mdakits.mdanalysis.org/mdakits.html">MDAKit registry</a> is still in its infancy, 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 <a class="reference external" href="https://github.com/MDAnalysis/MDAKits/issues">issue tracker</a> if you
have any questions.</p>
</div>
<dl class="simple">
<dt>Adding an MDAKit is a simple process, and follows the following steps:</dt><dd><ul class="simple">
<li><p>Create a fork the MDAKit repository</p></li>
<li><p>Create a fork the MDAKit repository <a class="reference external" href="https://github.com/MDAnalysis/mdakits">https://github.com/MDAnalysis/mdakits</a></p></li>
<li><p>Make a new branch</p></li>
<li><p>Add a new folder under <code class="docutils literal notranslate"><span class="pre">mdakits</span></code> with the name of your MDAKit</p></li>
<li><p>Add a metadata YAML file with your MDAKit’s details (a template can be found under <code class="docutils literal notranslate"><span class="pre">mdakits/template</span></code>)</p></li>
Expand Down

0 comments on commit 6188a57

Please sign in to comment.