Documentation update (#8)

* documentation in init and readme updated * docu change finished * version problems resolved --------- Co-authored-by: Konstantin Ntokas <[email protected]>
konstntokas · Jun 27, 2023 · fe4f4c2 · fe4f4c2
1 parent 0fbdcd7
commit fe4f4c2
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 25 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -26,7 +26,7 @@ jobs:
         python -m pip install flake8 pytest pytest-cov build
         python -m build
         cd dist
-        python -m pip install norton_beer-1.0.0-py3-none-any.whl
+        python -m pip install norton_beer-1.0.1-py3-none-any.whl
         cd ..
     - name: Lint with flake8
       run: |

diff --git a/CITATION.cff b/CITATION.cff
@@ -1,11 +1,11 @@
-cff-version: 1.0.0
+cff-version: 1.0.1
 message: "If you use this software, please cite it as below."
 authors:
 - family-names: "Ntokas"
   given-names: "Konstantin Franz Fotios"
   orcid: "https://orcid.org/0000-0002-0049-0690"
-title: "Norton-Beer apodization python pachage"
-version: 1.0.0
+title: "Norton-Beer apodization python package"
+version: 1.0.1
 doi: 10.5281/zenodo.8060761
 date-released: 2023-04-12
 url: "https://github.com/konstntokas/norton_beer"
diff --git a/README.md b/README.md
@@ -32,6 +32,5 @@ Note that pytest needs to be installed on the local machine.
 
 ## Documentation
 
-- add paper when published
-- add webpage of sphinx built documentation
+- [Documentation](https://norton-beer.readthedocs.io/en/latest/norton_beer.html)
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,7 +15,7 @@
 project = 'Norton-Beer apodization'
 copyright = '2023, Konstantin Ntokas'
 author = 'Konstantin Ntokas'
-release = '1.0.0'
+release = '1.0.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/source/norton_beer.rst b/docs/source/norton_beer.rst
@@ -5,9 +5,9 @@ Module contents
 ---------------
 
 .. automodule:: norton_beer
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Submodules
 ----------
@@ -16,22 +16,23 @@ norton\_beer.apodization module
 -------------------------------
 
 .. automodule:: norton_beer.apodization
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 norton\_beer.ils module
 -----------------------
 
 .. automodule:: norton_beer.ils
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 norton\_beer.optimize module
 ----------------------------
 
 .. automodule:: norton_beer.optimize
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "norton_beer"
-version = "1.0.0"
-description= "norton_beer 1.0.0"
+version = "1.0.1"
+description= "norton_beer 1.0.1"
 readme = "README.md"
 authors = [
     {name = "Konstantin Ntokas", email="[email protected]"},

diff --git a/src/norton_beer/__init__.py b/src/norton_beer/__init__.py
@@ -11,10 +11,6 @@
     3. generation of new apodization window for a fixed spatial
        resolution of the ILS so that the sides lobes are minimized
 
-Documentation:
-    1. add paper when published
-    2. add webpage of sphinx built documentation
-
 Installation
 ------------