Merge pull request #604 from afshin/update-changelog

Move Changelog to Standard Location

Author: blink1073

.github/workflows/ci.yml

@@ -60,6 +60,11 @@ jobs:
       timeout-minutes: 30
       run: |
         pytest ipykernel -vv -s --cov ipykernel --cov-branch --cov-report term-missing:skip-covered --durations 10
+    - name: Build the docs
+      run: |
+        cd docs
+        pip install -r requirements.txt
+        make html
     - name: Build and check the dist files
       run: |
         pip install build twine

.gitignore

@@ -24,3 +24,6 @@ __pycache__
 
 data_kernelspec
 .pytest_cache
+
+# copied changelog file
+docs/changelog.md

docs/changelog.md CHANGELOG.mddocs/changelog.md renamed to CHANGELOG.md

@@ -15,6 +15,7 @@
 import sys
 import os
 import shlex
+import shutil
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -151,7 +152,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -304,3 +305,8 @@
     'ipython': ('https://ipython.readthedocs.io/en/latest', None),
     'jupyter': ('https://jupyter.readthedocs.io/en/latest', None),
 }
+
+
+def setup(app):
+    here = os.path.dirname(os.path.abspath(__file__))
+    shutil.copy(os.path.join(here, '..', 'CHANGELOG.md'), 'changelog.md')