diff --git a/.gitignore b/.gitignore index c13b759..c5a3679 100644 --- a/.gitignore +++ b/.gitignore @@ -162,3 +162,5 @@ cython_debug/ # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ .pdm-python +/docs/source/CHANGELOG.md +/docs/html/ diff --git a/docs/source/conf.py b/docs/source/conf.py index a841bc8..253bd4e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -56,3 +56,14 @@ "source_branch": "main", "source_directory": "docs/", } + + +# ------------- Copying things +import os +import shutil + +docs_source_dir = os.path.abspath(os.path.dirname(__file__)) +project_root_dir = os.path.abspath(os.path.join(docs_source_dir, '..', '..')) +changelog_src = os.path.join(project_root_dir, 'CHANGELOG.md') +changelog_dest = os.path.join(docs_source_dir, 'CHANGELOG.md') +shutil.copyfile(changelog_src, changelog_dest) diff --git a/docs/source/index.md b/docs/source/index.md index e2ca4b2..127866a 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -23,6 +23,7 @@ measure and analyze the performance of your Python packages. :caption: Contents apidocs/index +CHANGELOG ``` ## Indices and tables