diff --git a/doc/source/conf.py b/doc/source/conf.py index 0384b71b..3f10af3e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -45,13 +45,14 @@ "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.viewcode", + "myst_parser", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = ".rst" +source_suffix = [".rst", ".md"] # The encoding of source files. # source_encoding = 'utf-8-sig' diff --git a/doc/source/contributing.md b/doc/source/contributing.md new file mode 100644 index 00000000..78caf34e --- /dev/null +++ b/doc/source/contributing.md @@ -0,0 +1,2 @@ +```{include} ../CONTRIBUTING.md +``` diff --git a/doc/source/index.rst b/doc/source/index.rst index 904200f5..cfa6dcf7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,7 +24,7 @@ Sections api artifact build - using_jenkinsapi + contributing Important Links --------------- diff --git a/test-requirements.txt b/test-requirements.txt index 0d07d562..efc2b376 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,6 +6,7 @@ astroid>=1.4.8 pylint>=1.7.1 tox>=2.3.1 mock +myst-parser codecov requests_kerberos flake8