Add information about how to contribute

.gitignore

@@ -15,6 +15,8 @@ __pycache__
 docs/_build/
 docs/src/generated/
 docs/src/ssg_execution_times.rst
+docs/src/README.rst
+tools/documentation_developer/CONTRIBUTING.rst
 
 # file generated by hatch
 src/hidimstat/_version.py

CONTRIBUTING.rst

@@ -1,3 +1,5 @@
+.. _quickstart_reference:
+
 .. ## for plotting and for examples 
     #TODO Need to be updated if it's necessary
 .. |MatplotlibMinVersion| replace:: 3.9.0

README.rst

@@ -103,8 +103,9 @@ User installation
 
 HiDimStat can easily be installed via ``pip``. For more installation information,
 see the `installation instructions <https://hidimstat.github.io/dev/index.html#installation>`_.
-::
-  pip install -U hidimstat 
+
+.. code::sh
+    pip install -U hidimstat 
 
 Contribute
 ----------
@@ -123,6 +124,8 @@ If you want to contribute directly to the library, check the
 `how to contribute <https://hidimstat.github.io/dev/how_to_contribute.html/>`_ page 
 on the website for more information.
 
+.. _contact_us:
+
 Contact us
 ----------
 

docs/Makefile

@@ -61,6 +61,8 @@ clean:
 	rm -rfv $(BUILDDIR)/*
 	rm -rfv $(SOURCEDIR)/generated/*
 	rm -rfv $(SOURCEDIR)/sg_execution_times.rst
+	rm -rfv $(SOURCEDIR)/README.rst
+	rm -rfv $(SOURCEDIR)/dev/CONTRIBUTING.rst
 
 html-noplot:
 	$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

docs/src/index.rst

@@ -182,4 +182,5 @@ References
 
   api
   generated/gallery/examples/index
+  dev/CONTRIBUTING
   dev/index

docs/tools/conf.py

@@ -28,6 +28,7 @@
 # We avoid duplicating the information, but we do not use symlinks to be
 # able to build the docs on Windows
 shutil.copyfile("../../CONTRIBUTING.rst", "../src/dev/CONTRIBUTING.rst")
+shutil.copyfile("../../README.rst", "../src/README.rst")
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -86,7 +87,8 @@
         },
     ],
     "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
-    "header_links_before_dropdown": 4,
+    "header_links_before_dropdown": 2,
+    "header_dropdown_text": "Contributing / More",
 }
 html_title = "HiDimStat"
 html_context = {