Issue #285 add CHANGELOG to docs

Open-EO · Jul 1, 2022 · f3fd3c5 · f3fd3c5
1 parent b8626a9
commit f3fd3c5
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 8 deletions.
diff --git a/CHANGELOG.md b/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
 
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```
diff --git a/docs/conf.py b/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'

diff --git a/docs/index.rst b/docs/index.rst
@@ -63,6 +63,7 @@ Table of contents
    process_mapping
    development
    best_practices
+   changelog
 
 
 Indices and tables

diff --git a/docs/udf.rst b/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
 

diff --git a/setup.py b/setup.py
@@ -54,6 +54,7 @@
               "sphinx-autodoc-annotation",
               "sphinx-autodoc-typehints",
               "flake8",
+              "myst-parser",
           ]
       },
       entry_points={