Add the CONTRIBUTING.md guide to the docs as a page

PyFilesystem · Nov 16, 2021 · 6bea7d4 · 6bea7d4
1 parent b71cacd
commit 6bea7d4
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 # the bare requirements for building docs
 Sphinx ~=3.0
 sphinx-rtd-theme ~=0.5.1
+recommonmark ~=0.6
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,7 +39,8 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
-    'sphinx.ext.intersphinx'
+    'sphinx.ext.intersphinx',
+    "recommonmark",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -63,7 +64,7 @@
 
 # General information about the project.
 project = u'PyFilesystem'
-copyright = u'2016-2017, Will McGugan'
+copyright = u'2016-2021, Will McGugan and the PyFilesystem2 contributors'
 author = u'Will McGugan'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/source/contributing.md b/docs/source/contributing.md
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,7 +25,7 @@ Contents:
    external.rst
    interface.rst
    reference.rst
-
+   contributing.md
 
 
 Indices and tables