From cb510644b2fd65e4ce216a7799ce7401f71548b8 Mon Sep 17 00:00:00 2001
From: Nathan Cassereau <84033440+ncassereau-idris@users.noreply.github.com>
Date: Fri, 19 Nov 2021 11:06:48 +0100
Subject: [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
---
 .github/CONTRIBUTING.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

(limited to '.github')

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 54e7e42..9bc8e87 100644
--- a/.github/CONTRIBUTING.md
+++ b/.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/),
-- 
cgit v1.2.3