From 2832a6d35770f01fc63eac249415d87803930984 Mon Sep 17 00:00:00 2001 From: "Antonios P. Sarikas" Date: Sun, 19 Jan 2025 22:53:08 +0200 Subject: [PATCH] docs: populate changelog for new version `2.0.0` Additional changes: * Customize RTDs theme --- docs/source/_static/custom.css | 3 +++ docs/source/changes.rst | 23 +++++++++++++++++++---- docs/source/conf.py | 5 ++++- 3 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 docs/source/_static/custom.css diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 0000000..aaff26a --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,3 @@ +.wy-side-nav-search { + background: #efefef; +} diff --git a/docs/source/changes.rst b/docs/source/changes.rst index d89615f..bee4a9b 100644 --- a/docs/source/changes.rst +++ b/docs/source/changes.rst @@ -1,22 +1,37 @@ 📌 Changelog ============ +Version 0.2.0 +------------- + +.. versionchanged:: 0.2.0 + + * Storing scheme for energy voxels. They are now stored as (individual) plain + ``.npy`` files (:issue:`8`). + +.. versionremoved:: 0.2.0 + + * :mod:`moxel.visualize` since PyVista already provides a simple way to + visualize voxels (:issue:`9`). + * :mod:`moxel.utils.batch_clean` since it is no longer necessary to "clean" + voxels due to new storing scheme. + Version 0.1.2 ------------- .. versionadded:: 0.1.2 - * :func:`moxel.utils.load_json` - * Documentation for the CLI. + * :func:`moxel.utils.load_json` + * Documentation for the CLI. .. versionremoved:: 0.1.2 - * :func:`moxel.utils.get_names` + * :func:`moxel.utils.get_names` Version 0.1.1 ------------- -* Add performance enhancements proposed by :user:`fxcoudert`. See PR :pr:`2, 3`. +* Performance enhancements proposed by :user:`fxcoudert`. See PR :pr:`2, 3`. * Fix bug in :mod:`moxel.visualize` where plots didn't render. Version 0.1.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index 13a6b1b..484ab06 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -45,7 +45,10 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinx_rtd_theme' -#html_static_path = ['_static'] +html_logo = 'images/moxel_logo.svg' +html_theme_options = {'logo_only': True} +html_static_path = ['_static'] +html_css_files = ['custom.css'] # Path to GitHub repo {group}/{project} (note that `group` is the GitHub user or organization) issues_github_path = "adosar/moxel"