Merge pull request #47 from naik-aakash/master

Docs-changelog-automatic-update
JaGeo · May 25, 2022 · e4e9728 · e4e9728
2 parents 0e4e8d5 + 7c04230
commit e4e9728
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,14 @@
-# v0.2.2
+## v0.2.2
 - users can provide their own basis functions for lobsterin/INCAR generation
 - documentation added
 - fixes to saving files
 
-# v0.2.1
+## v0.2.1
 - Fix error message when LobsterPy is used in cation-anion mode for materials that are not ionic.
 - automatic plots are now saved correctly. Before only the last plot was saved.
 - Additional Gaussian broadening available for COHPs
 - lobsterins can be generated with the command-line interface
-# v0.1.0
+## v0.1.0
 - First LobsterPy release
 - Automatic COHP analysis (description and plots)
 - Command line tool to perform automatic analysis

diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
diff --git a/docs/changelog_link.rst b/docs/changelog_link.rst
@@ -0,0 +1,4 @@
+CHANGELOG
+================
+
+.. mdinclude:: ../CHANGELOG.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,11 +10,11 @@ Lobsterpy's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   README
+   readme_link
    tutorials
    modules
-   CHANGELOG
-   LICENSE
+   changelog_link
+   license_link
 
 
 

diff --git a/docs/LICENSE.rst → docs/license_link.rst b/docs/LICENSE.rst → docs/license_link.rst
diff --git a/docs/README.rst → docs/readme_link.rst b/docs/README.rst → docs/readme_link.rst
@@ -7,7 +7,6 @@ Getting started
 .. figure:: Logo.png
    :alt: LobsterPy Logo
 
-   LobsterPy Logo
 
 This is a package that enables automatic plotting of Lobster outputs. You can download Lobster on http://www.cohp.de. Currently, only VASP/Lobster computations are supported.
 
@@ -64,3 +63,4 @@ Contributions
    :target: https://pypi.org/project/lobsterpy
 .. |DOI| image:: https://zenodo.org/badge/343384088.svg
    :target: https://zenodo.org/badge/latestdoi/343384088
+