Bump changelog before release

SMTG-Bham · Aug 23, 2023 · d49479d · d49479d
1 parent 41d5ec3
commit d49479d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,5 +1,13 @@
 Change Log
 ==========
+
+v.2.0.0
+----------
+- Major overhaul to rebase onto the new `pymatgen` defects code (`>v2022.7.25`).
+- Add documentation (https://doped.readthedocs.io/en/latest)
+- Add `DefectsGenerator` class with major upgrade in functionality.
+- Add `DefectsSet` classes in `vasp.py`
+
 v.1.1.2
 ----------
 - Cap `numpy` to `1.23` to avoid `pymatgen` dependency issues.

diff --git a/docs/Tips.rst b/docs/Tips.rst
@@ -24,7 +24,7 @@ either:
   is the case.
 
 Difficult Structural Relaxations
--------------------
+--------------------------------
 
 If defect supercell relaxations do not converge after multiple continuation calculations
 (i.e. ``cp``-ing ``CONTCAR`` to ``POSCAR`` and resubmitting the job), this is likely due to an error in

diff --git a/docs/changelog_link.rst b/docs/changelog_link.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -164,11 +164,20 @@ Studies using ``doped``
 
 .. toctree::
    :hidden:
+   :caption: Usage
    :maxdepth: 4
 
    Installation
    Python API <doped>
    Tutorials
    Tips
+
+.. toctree::
+   :hidden:
+   :caption: Information
+   :maxdepth: 1
+
    Contributing
    Code_Compatibility
+   changelog_link
+   doped on GitHub <https://github.com/SMTG-UCL/doped>