Now using MYST_PARSER and solving links issue in the README.md / onli…

…ne docs
PythonOT · Dec 9, 2021 · 86faaa4 · 86faaa4
1 parent d02f71a
commit 86faaa4
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -202,12 +202,12 @@ This toolbox benefit a lot from open source research and we would like to thank
 
 * [Gabriel Peyré](http://gpeyre.github.io/) (Wasserstein Barycenters in Matlab)
 * [Mathieu Blondel](https://mblondel.org/) (original implementation smooth OT)
-* [Nicolas Bonneel](http://liris.cnrs.fr/~nbonneel/) ( C++ code for EMD)
+* [Nicolas Bonneel](http://liris.cnrs.fr/~nbonneel/) (C++ code for EMD)
 * [Marco Cuturi](http://marcocuturi.net/) (Sinkhorn Knopp in Matlab/Cuda)
 
 ## Contributions and code of conduct
 
-Every contribution is welcome and should respect the [contribution guidelines](https://pythonot.github.io/contributing.html). Each member of the project is expected to follow the [code of conduct](https://pythonot.github.io/code_of_conduct.html).
+Every contribution is welcome and should respect the [contribution guidelines](.github/CONTRIBUTING.md). Each member of the project is expected to follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
 
 ## Support
 
@@ -217,7 +217,7 @@ You can ask questions and join the development discussion:
 * On the POT [gitter channel](https://gitter.im/PythonOT/community)
 * On the POT [mailing list](https://mail.python.org/mm3/mailman3/lists/pot.python.org/)
 
-You can also post bug reports and feature requests in Github issues. Make sure to read our [guidelines](https://pythonot.github.io/contributing.html) first.
+You can also post bug reports and feature requests in Github issues. Make sure to read our [guidelines](.github/CONTRIBUTING.md) first.
 
 ## References
 

diff --git a/benchmarks/benchmark.py b/benchmarks/benchmark.py
@@ -84,8 +84,8 @@ def convert_to_html_table(results, param_name, main_title=None, comments=None):
 
         # make device header
         string += f'<tr><th align="center">Device</th>'
-        string += f'<th align="center" colspan="{cpus_cols}"">CPU</th>'
-        string += f'<th align="center" colspan="{gpus_cols}">GPU</tr>\n'
+        string += f'<th align="center" colspan="{cpus_cols}">CPU</th>'
+        string += f'<th align="center" colspan="{gpus_cols}">GPU</th></tr>\n'
 
         # make param_name / backend header
         string += f'<tr><th align="center">{param_name}</th>'

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,5 +4,4 @@ numpydoc
 memory_profiler
 pillow
 networkx
-mistune==0.8.4
-m2r2
+myst-parser
diff --git a/docs/requirements_rtd.txt b/docs/requirements_rtd.txt
@@ -3,8 +3,7 @@ numpydoc
 memory_profiler
 pillow
 networkx
-mistune==0.8.4
-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
@@ -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
@@ -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
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -69,7 +69,7 @@ def __getattr__(cls, name):
     '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
diff --git 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