Skip to content

Commit 6bea7d4

Browse files
committed
Add the CONTRIBUTING.md guide to the docs as a page
1 parent b71cacd commit 6bea7d4

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# the bare requirements for building docs
22
Sphinx ~=3.0
33
sphinx-rtd-theme ~=0.5.1
4+
recommonmark ~=0.6

docs/source/conf.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
'sphinx.ext.autodoc',
4040
'sphinx.ext.viewcode',
4141
'sphinx.ext.napoleon',
42-
'sphinx.ext.intersphinx'
42+
'sphinx.ext.intersphinx',
43+
"recommonmark",
4344
]
4445

4546
# Add any paths that contain templates here, relative to this directory.
@@ -63,7 +64,7 @@
6364

6465
# General information about the project.
6566
project = u'PyFilesystem'
66-
copyright = u'2016-2017, Will McGugan'
67+
copyright = u'2016-2021, Will McGugan and the PyFilesystem2 contributors'
6768
author = u'Will McGugan'
6869

6970
# The version info for the project you're documenting, acts as replacement for

docs/source/contributing.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CONTRIBUTING.md

docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Contents:
2525
external.rst
2626
interface.rst
2727
reference.rst
28-
28+
contributing.md
2929

3030

3131
Indices and tables

0 commit comments

Comments
 (0)