Polish documentation for v0.1.0 (#18)

adriesse · web-flow · commit 5579d030da1e · 2025-02-02T22:01:53.000+01:00
* Update logo
* Add dark logo
* Correct file names
* Tools for PV!
* Update Changelog
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# PV Performance Labs Tools for Python
+# PV Performance Labs Tools for PV
 
 *Useful tools for photovoltaics and beyond!*
 
@@ -64,7 +64,7 @@ When referring to this software in an academic or commercial context,
 please use a citation similar to the following:
 
   A. Driesse,
-  "PV Performance Labs Tools for Python", (2025), GitHub repository,
+  "PV Performance Labs Tools for PV", (2025), GitHub repository,
   https://github.com/pvplabs/pvpltools
 
 When referring to specific functions, docs strings or algorithms,
diff --git a/README_PYPI.md b/README_PYPI.md
@@ -1,4 +1,4 @@
-# PV Performance Labs Tools for Python
+# PV Performance Labs Tools for PV
 
 *Useful tools for photovoltaics and beyond!*
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -109,6 +109,10 @@
 # https://pydata-sphinx-theme.rtfd.io/en/latest/user_guide/configuring.html
 
 html_theme_options = {
+    "logo": {
+        "text": "PV Performance Labs",
+        "image_dark": "static/pvplabs_logo_dark.png",
+    },
     "github_url": "https://github.com/pvplabs/pvpltools",
     "icon_links": [
         {
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
-PV Performance Labs Tools for Python
-=====================================
+PV Performance Labs Tools for PV
+================================
 
 *Useful tools for photovoltaics and beyond!*
 
diff --git a/docs/static/pvplabs_logo_dark.png b/docs/static/pvplabs_logo_dark.png
diff --git a/docs/whatsnews/0.0.0-pre-PyPI-release.rst b/docs/whatsnews/0.0.0-pre-PyPI-release.rst
@@ -35,14 +35,14 @@ Historical notes
 
 * The new module ``module_efficiency.py`` contains functions for:
 
-    - the new ADR model
-    - HEY
-    - MotherPV
-    - PVGIS
-    - MPM5
-    - MPM6
-    - bilinear
-    - fitting any of the models to measurements
+  * the new ADR model
+  * HEY
+  * MotherPV
+  * PVGIS
+  * MPM5
+  * MPM6
+  * bilinear
+  * fitting any of the models to measurements
 
 
 2020-02-29
diff --git a/docs/whatsnews/0.1.0.rst b/docs/whatsnews/0.1.0.rst
@@ -1,6 +1,14 @@
-v0.1.0 (very soon!)
+v0.1.0 (2025-02-02)
 -------------------
 
-* First official release of the project on PyPI.
-* Documentation published on readthedocs.org.
+First release of pvpltools on PyPI.
 
+* Same functionality as adriesse/pvpltools-python
+* Tested on Python 3.8 - 3.13
+* Documentation published on readthedocs.org
+
+Many thanks to
+`Echedey Luis <https://github.com/echedey-ls>`_
+for helping me get this set up!
+
+The stage is now set for adding some new functionality...

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# PV Performance Labs Tools for Python`
	`1`	`+# PV Performance Labs Tools for PV`
`2`	`2`
`3`	`3`	`Useful tools for photovoltaics and beyond!`
`4`	`4`