rmm commited on
Commit
de8eaa8
·
1 Parent(s): 0c2d618

docs: added markdown files for all active py modules

Browse files
docs/fix_tabrender.md ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+
2
+ A js fix for certain UI elements, including maps, getting rendered into a
3
+ zero-sized frame by default. Here we resize it so it is visible once the tab is
4
+ clicked and no further interaction is required to see it.
5
+
6
+ ::: call_models.fix_tabrender
docs/input_handling.md ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+
2
+ ::: call_models.input_handling
docs/main.md ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+
2
+ # Main entry point to the frontend
3
+
4
+ ::: call_models.entry_and_hotdog
docs/obs_map.md ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+
2
+ ::: call_models.obs_map
docs/st_logs.md ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ This module is about using a standard python logger within streamlit.
2
+
3
+
4
+ # Streamlit log handler
5
+
6
+ ::: call_models.st_logs
7
+
docs/whale_gallery.md ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+
2
+ ::: call_models.whale_gallery
docs/whale_viewer.md ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+
2
+ ::: call_models.whale_viewer
mkdocs.yaml CHANGED
@@ -21,4 +21,17 @@ plugins:
21
 
22
 
23
  nav:
24
- - README: index.md
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
 
23
  nav:
24
+ - README: index.md
25
+ - API:
26
+ - Main app: main.md
27
+ - Data entry handling: input_handling.md
28
+ - Whale gallery: whale_gallery.md
29
+ - Whale viewer: whale_viewer.md
30
+ - Map of observations: obs_map.md
31
+ - Logging: st_logs.md
32
+ - Tab-rendering fix (js): fix_tabrender.md
33
+
34
+
35
+
36
+ - Development clutter:
37
+ - Demo app: app.md