Issue #285 add CHANGELOG to docs

Author: soxofaan

CHANGELOG.md

@@ -390,7 +390,7 @@ Minor release to address version packaging issue.
 - Moved datacube write/save/plot utilities from udf to client (EP-3456)
 - Add documentation on OpenID Connect authentication (EP-3485)
 
-## Fixed
+### Fixed
 - Fix `kwargs` handling in `TimingLogger` decorator
 
 

docs/changelog.md

@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```

docs/conf.py

@@ -40,17 +40,18 @@
     'sphinx_autodoc_typehints',
     'sphinx.ext.viewcode',
     'sphinx.ext.doctest',
+    'myst_parser',
 ]
 
 import sphinx_autodoc_typehints
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # 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": "restructuredtext",
+    ".md": "markdown",
+}
 
 # The master toctree document.
 master_doc = 'index'

docs/index.rst

@@ -63,6 +63,7 @@ Table of contents
    process_mapping
    development
    best_practices
+   changelog
 
 
 Indices and tables

docs/udf.rst

@@ -261,17 +261,17 @@ Illustration of data chunking in ``apply`` with a  UDF
 TODO
 
 Example: ``apply_dimension`` with a UDF
-======================================
+========================================
 
 TODO
 
 Example: ``reduce_dimension`` with a UDF
-======================================
+========================================
 
 TODO
 
 Example: ``apply_neighborhood`` with a UDF
-=========================================
+===========================================
 
 TODO
 

setup.py

@@ -54,6 +54,7 @@
               "sphinx-autodoc-annotation",
               "sphinx-autodoc-typehints",
               "flake8",
+              "myst-parser",
           ]
       },
       entry_points={