Skip to content

update links to the MDA cookiecutter docs #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
orbeckst wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update links to the MDA cookiecutter docs #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c0bab9
update links to the MDA cookiecutter docs
orbeckst Jan 29, 2026
e319ced
Merge branch 'main' into doc-update-mdacc-links
orbeckst Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/source/maintaining_a_kit/logo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ on updating this.


.. _`MDAKits cookiecutter documentation`:
https://cookiecutter-mdakit.readthedocs.io/en/latest/usage.html#documentation-configuration

https://www.mdanalysis.org/cookiecutter-mdakit/usage.html#documentation-configuration

.. _`'empty gear' template`:
https://github.com/MDAnalysis/branding/tree/main/templates/MDAKits
Expand Down
15 changes: 9 additions & 6 deletions docs/source/making_a_kit/guided_example/use-cookiecutter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
************************************
Part 1: Using the MDAKit cookicutter
************************************
*************************************
Part 1: Using the MDAKit cookiecutter
*************************************

*See our* `YouTube tutorial <https://www.youtube.com/watch?v=viCPUHkgSxg&t=38s>`_
*for a video demonstration of this section.*
Expand Down Expand Up @@ -105,8 +105,11 @@ Progress: MDAKit requirements

.. _`Cookiecutter tool`: https://cookiecutter.readthedocs.io/en/stable/

.. _`MDAKit cookiecutter documentation`: https://cookiecutter-mdakit.readthedocs.io/en/latest/
.. _`MDAKit cookiecutter documentation`:
https://www.mdanalysis.org/cookiecutter-mdakit

.. _`cookiecutter options`: https://cookiecutter-mdakit.readthedocs.io/en/latest/options
.. _`cookiecutter options`:
https://www.mdanalysis.org/cookiecutter-mdakit/getting_started.html#options.io/en/latest/options

.. _`cookiecutter usage`: https://cookiecutter-mdakit.readthedocs.io/en/latest/usage
.. _`cookiecutter usage`:
https://www.mdanalysis.org/cookiecutter-mdakit/getting_started.html#basic-usage
4 changes: 3 additions & 1 deletion docs/source/makingakit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Building a Kit using the cookiecutter
-------------------------------------

Without prior experience, some of the MDAKit Registry requirements
can be daunting. The `MDAKit cookiecutter <https://cookiecutter-mdakit.readthedocs.io/>`_
can be daunting. The `MDAKit cookiecutter`_
can be used to aid rapid development of a FAIR-compliant MDAKit
by generating placeholder code for documentation, testing and
installation. A guided example of creating an MDAKit, from cookiecutter
Expand Down Expand Up @@ -42,3 +42,5 @@ information below.
making_a_kit/hosting
making_a_kit/testing
making_a_kit/documentation

.. _`MDAKit cookiecutter`: https://www.mdanalysis.org/cookiecutter-mdakit