From e93f90259ee01307424b5b5615f7d74807e5db82 Mon Sep 17 00:00:00 2001 From: MJZ0001 <88413037+marvelousmonicaaa@users.noreply.github.com> Date: Fri, 31 May 2024 12:38:54 -0400 Subject: [PATCH] link contributing instruction to sphinx --- docs/contributing.md | 2 +- docs/contributing_link.rst | 1 + docs/index.rst | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 docs/contributing_link.rst diff --git a/docs/contributing.md b/docs/contributing.md index f46f0c8..8d8a646 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -# Contributing to [Your Package Name] +# Contributing to pySLM2 Thank you for considering contributing to `pySLM2`! Here are a few guidelines to help you get started. diff --git a/docs/contributing_link.rst b/docs/contributing_link.rst new file mode 100644 index 0000000..ce9bd4b --- /dev/null +++ b/docs/contributing_link.rst @@ -0,0 +1 @@ +.. mdinclude:: contributing.md \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 58ffe40..c058d14 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Welcome to pySLM2's documentation! pySLM2 pySLM2.util examples + contributing_link Indices and tables