docs: Fixed installation and core page indexing (#112)

* docs: Fixed docstring of Engine * docs: Fixed installation page indexing
pyronear · Aug 6, 2022 · 3174db7 · 3174db7
1 parent 22c5981
commit 3174db7
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -93,6 +93,7 @@
     "source_repository": "https://github.com/pyronear/pyro-engine/",
     "source_branch": "develop",
     "source_directory": "docs/source/",
+    "sidebar_hide_name": True,
 }
 
 

diff --git a/docs/source/core.rst b/docs/source/core.rst
@@ -5,12 +5,11 @@ The models subpackage contains everything to manage the whole Fire Detection pro
 by predicting whether there is a fire on this image
 
 
-.. currentmodule:: pyroengine.core
+.. currentmodule:: pyroengine
 
-Engine
-------
 
 .. autoclass:: Engine
+
 	.. automethod:: clear_cache
 	.. automethod:: predict
 	.. automethod:: heartbeat
diff --git a/docs/source/installation.rst → docs/source/installing.rst b/docs/source/installation.rst → docs/source/installing.rst
diff --git a/pyroengine/core.py b/pyroengine/core.py
@@ -45,9 +45,9 @@ class Engine:
     Examples:
         >>> from pyroengine import Engine
         >>> cam_creds ={
-        "cam_id_1": {'login':'log1', 'password':'pwd1'},
-        "cam_id_2": {'login':'log2', 'password':'pwd2'},
-        }
+        >>> "cam_id_1": {'login':'log1', 'password':'pwd1'},
+        >>> "cam_id_2": {'login':'log2', 'password':'pwd2'},
+        >>> }
         >>> pyroEngine = Engine("pyronear/rexnet1_3x", 0.5, 'https://api.pyronear.org', cam_creds, 48.88, 2.38)
     """