share the changelog with docs too

henrysky · Aug 30, 2023 · ee6fd59 · ee6fd59
1 parent 7ad9395
commit ee6fd59
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,6 @@
-## [0.11.0] - WIP
+# Change log
+
+## [0.11.0] - X XXX 2023
 ### Changed
 - Using new Matplotlib `pcolormesh` API introduced in v3.7.0 to plot sky map with projections faster with less memory
 - Add option to plot galactic grid, equatorial grid and ecliptic grid in sky map

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -11,4 +11,5 @@ sphinx-copybutton
 bokeh
 sphinx
 nbsphinx
-ipykernel
+ipykernel
+myst_parser
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,2 @@
+```{include} ../../CHANGELOG.md
+```
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -41,7 +41,8 @@
               'sphinx.ext.viewcode',
               'sphinx-prompt',
               'bokeh.sphinxext.bokeh_plot', 
-              'sphinx_copybutton']
+              'sphinx_copybutton',
+              'myst_parser']
 
 bokeh_plot_pyfile_include_dirs = ['bokeh_html']
 
@@ -52,7 +53,7 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'