Ouranosinc · Zeitsperre · Mar 8, 2023 · Feb 27, 2023 · Feb 27, 2023 · Feb 27, 2023
diff --git a/.github/CONTRIBUTING.rst → CONTRIBUTING.rst b/.github/CONTRIBUTING.rst → CONTRIBUTING.rst
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -50,6 +50,7 @@ Internal changes
 * Adding infer context to the unit conversion in of the training of ExtremeValues. (:pull:`1299`).
 * Added `sphinxcontrib-svg2pdfconverter` for converting SVG graphics within documentation to PDF-compatible images. (:pull:`1296`).
 * README badges for supported Python versions and repository health have been added. (:issue:`1304`, :pull:`1307`).
+* CONTRIBUTING has been moved to the top level, license information clearly in README, use of `sphinx-autodoc-typehints` in documentation. (:issue:`1305`, :pull:`1308`).
 
 0.40.0 (2023-01-13)
 -------------------

diff --git a/README.rst b/README.rst
@@ -54,13 +54,21 @@ xclim is in active development and is being used in production by climate servic
 * If you would like to contribute code or documentation (which is greatly appreciated!), check out the `Contributing Guidelines`_ before you begin!
 
 .. _issue tracker: https://github.com/Ouranosinc/xclim/issues
-.. _Contributing Guidelines: https://github.com/Ouranosinc/xclim/blob/master/.github/CONTRIBUTING.rst
+.. _Contributing Guidelines: https://github.com/Ouranosinc/xclim/blob/master/CONTRIBUTING.rst
 
 How to cite this library
 ------------------------
 If you wish to cite xclim in a research publication, we kindly ask that you use the bibliographical reference information available through `Zenodo`_
 
-.. _Zenodo: https://doi.org/10.5281/zenodo.2795043
+.. _Zenodo: https://doi.org/10.5281/zenodo.2795043S
+
+License
+-------
+This is free software: you can redistribute it and/or modify it under the terms of the `Apache License 2.0`_. A copy of this license is provided in the code repository (`LICENSE`_).
+
+
+.. _Apache License 2.0: https://opensource.org/license/apache-2-0/
+.. _LICENSE: https://github.com/Ouranosinc/xclim/blob/master/LICENSE
 
 Credits
 -------

diff --git a/docs/api.rst b/docs/api.rst
@@ -6,6 +6,11 @@ The API of the statistical downscaling and bias adjustment module (sdba) is docu
 The API of the ``cfchecks``, ``datachecks``, ``missing`` and ``dataflags`` modules are in :ref:`checks:Health Checks`.
 Finally, the API of the translating tools is on the :ref:`internationalization:Internationalization` page.
 
+.. contents:: Table of Contents
+   :depth: 1
+   :local:
+   :backlinks: none
+
 Indicators
 ==========
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -108,6 +108,7 @@ def _indicator_table(module):
     "autodoc_indicator",
     "sphinxcontrib.bibtex",
     "sphinxcontrib.cairosvgconverter",
+    "sphinx_autodoc_typehints",
     "sphinx_codeautolink",
     "sphinx_copybutton",
     "sphinx_rtd_theme",

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1 +1 @@
-.. include:: ../.github/CONTRIBUTING.rst
+.. include:: ../CONTRIBUTING.rst
diff --git a/environment.yml b/environment.yml
@@ -52,6 +52,7 @@ dependencies:
     - pytest-cov
     - pytest-xdist>=3.2
     - sphinx
+    - sphinx-autodoc-typehints
     - sphinx-codeautolink
     - sphinx-copybutton
     - sphinx-rtd-theme>=1.0

diff --git a/pyproject.toml b/pyproject.toml
@@ -83,6 +83,7 @@ dev = [
   "netCDF4 >=1.4",
   "pooch",
   "sphinx",
+  "sphinx-autodoc-typehints",
   "sphinx-codeautolink",
   "sphinx-copybutton",
   "sphinx-rtd-theme >=1.0",
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		.. include:: ../.github/CONTRIBUTING.rst
		.. include:: ../CONTRIBUTING.rst