summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/requirements.txt2
-rw-r--r--docs/requirements_rtd.txt2
-rw-r--r--docs/source/.github/CODE_OF_CONDUCT.rst6
-rw-r--r--docs/source/.github/CONTRIBUTING.rst6
-rw-r--r--docs/source/code_of_conduct.rst1
-rw-r--r--docs/source/conf.py2
-rw-r--r--docs/source/contributing.rst1
-rw-r--r--docs/source/index.rst9
8 files changed, 19 insertions, 10 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 95147d2..2e060b9 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -4,4 +4,4 @@ numpydoc
memory_profiler
pillow
networkx
-m2r2 \ No newline at end of file
+myst-parser \ No newline at end of file
diff --git a/docs/requirements_rtd.txt b/docs/requirements_rtd.txt
index 5963ea2..11957fb 100644
--- a/docs/requirements_rtd.txt
+++ b/docs/requirements_rtd.txt
@@ -3,7 +3,7 @@ numpydoc
memory_profiler
pillow
networkx
-m2r2
+myst-parser
numpy
scipy>=1.0
cython
diff --git a/docs/source/.github/CODE_OF_CONDUCT.rst b/docs/source/.github/CODE_OF_CONDUCT.rst
new file mode 100644
index 0000000..d4c5cec
--- /dev/null
+++ b/docs/source/.github/CODE_OF_CONDUCT.rst
@@ -0,0 +1,6 @@
+Code of Conduct
+===============
+
+.. include:: ../../../.github/CODE_OF_CONDUCT.md
+ :parser: myst_parser.sphinx_
+ :start-line: 2
diff --git a/docs/source/.github/CONTRIBUTING.rst b/docs/source/.github/CONTRIBUTING.rst
new file mode 100644
index 0000000..aef24e9
--- /dev/null
+++ b/docs/source/.github/CONTRIBUTING.rst
@@ -0,0 +1,6 @@
+Contributing to POT
+===================
+
+.. include:: ../../../.github/CONTRIBUTING.md
+ :parser: myst_parser.sphinx_
+ :start-line: 3
diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst
deleted file mode 100644
index b37ba7b..0000000
--- a/docs/source/code_of_conduct.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. mdinclude:: ../../.github/CODE_OF_CONDUCT.md \ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 1320afa..849e97c 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -69,7 +69,7 @@ extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_gallery.gen_gallery',
- 'm2r2'
+ 'myst_parser'
]
autosummary_generate = True
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
deleted file mode 100644
index dc81e75..0000000
--- a/docs/source/contributing.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. mdinclude:: ../../.github/CONTRIBUTING.md \ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 7aaa524..8de31ae 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -17,12 +17,11 @@ Contents
all
auto_examples/index
releases
- contributing
- Code of Conduct <code_of_conduct>
-
-.. mdinclude:: ../../README.md
- :start-line: 2
+ .github/CONTRIBUTING
+ .github/CODE_OF_CONDUCT
+.. include:: ../../README.md
+ :parser: myst_parser.sphinx_
Indices and tables