Skip to content

Commit

Permalink
docs: populate changelog for new version 2.0.0
Browse files Browse the repository at this point in the history
Additional changes:
* Customize RTDs theme
  • Loading branch information
adosar committed Jan 19, 2025
1 parent 8124975 commit 2832a6d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
3 changes: 3 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-side-nav-search {
background: #efefef;
}
23 changes: 19 additions & 4 deletions docs/source/changes.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 2832a6d

Please sign in to comment.