From ee6fd5967455d61d1e566cf537874e030b409477 Mon Sep 17 00:00:00 2001 From: Henry Leung Date: Wed, 30 Aug 2023 15:56:01 -0400 Subject: [PATCH] share the changelog with docs too --- CHANGELOG.md | 4 +++- docs/requirements.txt | 3 ++- docs/source/changelog.md | 2 ++ docs/source/changelog.rst | 37 ------------------------------------- docs/source/conf.py | 5 +++-- 5 files changed, 10 insertions(+), 41 deletions(-) create mode 100644 docs/source/changelog.md delete mode 100644 docs/source/changelog.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index 6da2b62..c4e3418 100644 --- 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 index 27992b5..192bc8b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -11,4 +11,5 @@ sphinx-copybutton bokeh sphinx nbsphinx -ipykernel \ No newline at end of file +ipykernel +myst_parser \ No newline at end of file diff --git a/docs/source/changelog.md b/docs/source/changelog.md new file mode 100644 index 0000000..ff772da --- /dev/null +++ b/docs/source/changelog.md @@ -0,0 +1,2 @@ +```{include} ../../CHANGELOG.md +``` \ No newline at end of file diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst deleted file mode 100644 index 4ab02bf..0000000 --- a/docs/source/changelog.rst +++ /dev/null @@ -1,37 +0,0 @@ -Changelog -============= - -Version 1.0.dev ------------------- - -:Date: March 29, 2021 - - | **New features:** - - * New features - - | **Improvement:** - - * None - - | **Breaking Changes:** - - * None - - -Version 0.0 --------------- - -:Date: March 17, 2018 - - | **New features:** - - * Initial commit of this package - - | **Improvement:** - - * None - - | **Breaking Changes:** - - * None diff --git a/docs/source/conf.py b/docs/source/conf.py index 045fa79..ffe25e4 100644 --- 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'