Deploy documentation in github.io

jlgarridol · Apr 24, 2024 · 0baee2d · 0baee2d
1 parent a978145
commit 0baee2d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/make.py b/docs/make.py
@@ -26,7 +26,7 @@
 
         favicon=f"data:image/svg+xml;base64,{favicon}",
         logo=f"data:image/svg+xml;base64,{logo}",
-        logo_link="/",
+        logo_link="/sslearn",
         footer_text=f"pdoc {pdoc.__version__}",
         search=True,
         math=True,

diff --git a/sslearn/__init__.py b/sslearn/__init__.py
@@ -3,6 +3,9 @@
 if os.path.exists("../README.md"):
     with open("../README.md", "r") as f:
         __doc__ = f.read()
+elif os.path.exists("README.md"):
+    with open("README.md", "r") as f:
+        __doc__ = f.read()
 else:
     __doc__ = "Semi-Supervised Learning (SSL) is a Python package that provides tools to train and evaluate semi-supervised learning models."