diff options
author | Nathan Cassereau <84033440+ncassereau-idris@users.noreply.github.com> | 2021-11-19 11:06:48 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-19 11:06:48 +0100 |
commit | cb510644b2fd65e4ce216a7799ce7401f71548b8 (patch) | |
tree | 881a8e5478b5e2e9fd583ca961b86f8f73363422 /docs/source/conf.py | |
parent | 8b9e641645f7825255afacfd141bfbf52ba2857e (diff) |
[MRG] Solve bug of contribution link in docs + automated insert of readme in doc (#301)
* first try
* bug solve
* attempt to use m2r2
* More elegant dependency
* readme.rst now generated automatically from readme.md
* weird attempt
* Revert "weird attempt"
This reverts commit b45f0e6495148877ad3e93ad608b3b0cfe9bbb16.
* fixing readme links
* Revert "fixing readme links"
This reverts commit 0c6ca7612ea297674a3afc50f8e6538c58c27701.
* full link for readme
* correct CONTRIBUTING guidelines mistakes
Diffstat (limited to 'docs/source/conf.py')
-rw-r--r-- | docs/source/conf.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 9b5a719..1320afa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,6 +69,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinx_gallery.gen_gallery', + 'm2r2' ] autosummary_generate = True @@ -81,8 +82,8 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] +# source_suffix = '.rst' # The encoding of source files. source_encoding = 'utf-8-sig' |