[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 b45f0e6.

* fixing readme links

* Revert "fixing readme links"

This reverts commit 0c6ca76.

* full link for readme

* correct CONTRIBUTING guidelines mistakes

Author: ncassereau

.github/CONTRIBUTING.md

@@ -182,11 +182,10 @@ reStructuredText documents live in the source code repository under the
 doc/ directory.
 
 You can edit the documentation using any text editor and then generate
-the HTML output by typing ``make html`` from the doc/ directory.
+the HTML output by typing ``make html`` from the ``docs/`` directory.
 Alternatively, ``make`` can be used to quickly generate the
-documentation without the example gallery. The resulting HTML files will
-be placed in ``_build/html/`` and are viewable in a web browser. See the
-``README`` file in the ``doc/`` directory for more information.
+documentation without the example gallery with `make html-noplot`. The resulting HTML files will
+be placed in `docs/build/html/` and are viewable in a web browser.
 
 For building the documentation, you will need
 [sphinx](http://sphinx.pocoo.org/),

README.md

@@ -206,7 +206,7 @@ This toolbox benefit a lot from open source research and we would like to thank
 
 ## Contributions and code of conduct
 
-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).
+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).
 
 ## Support
 
@@ -216,7 +216,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](.github/CONTRIBUTING.md) first.
+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.
 
 ## References
 
@@ -299,4 +299,4 @@ Machine Learning (pp. 4104-4113). PMLR.
 Conference on Machine Learning, PMLR 119:4692-4701, 2020
 
 [38] C. Vincent-Cuaz, T. Vayer, R. Flamary, M. Corneli, N. Courty, [Online Graph 
-Dictionary Learning](https://arxiv.org/pdf/2102.06555.pdf), International Conference on Machine Learning (ICML), 2021.
+Dictionary Learning](https://arxiv.org/pdf/2102.06555.pdf), International Conference on Machine Learning (ICML), 2021.

docs/requirements.txt

@@ -4,3 +4,4 @@ numpydoc
 memory_profiler
 pillow
 networkx
+m2r2

docs/requirements_rtd.txt

@@ -3,6 +3,7 @@ numpydoc
 memory_profiler
 pillow
 networkx
+m2r2
 numpy
 scipy>=1.0
 cython

docs/source/code_of_conduct.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../.github/CODE_OF_CONDUCT.md

docs/source/conf.py

@@ -69,6 +69,7 @@ def __getattr__(cls, name):
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
     'sphinx_gallery.gen_gallery',
+    'm2r2'
 ]
 
 autosummary_generate = True
@@ -81,8 +82,8 @@ def __getattr__(cls, name):
 
 # 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'

docs/source/contributing.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../.github/CONTRIBUTING.md

docs/source/index.rst

@@ -17,8 +17,10 @@ Contents
    all
    auto_examples/index
    releases
+   contributing
+   Code of Conduct <code_of_conduct>
 
-.. include:: readme.rst
+.. mdinclude:: ../../README.md
    :start-line: 2