link contributing instruction to sphinx

QITI · May 31, 2024 · e93f902 · e93f902
1 parent 0fe1c0b
commit e93f902
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git 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
@@ -0,0 +1 @@
+.. mdinclude:: contributing.md
diff --git 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