Spaces:
Sleeping
Sleeping
rmm
commited on
Commit
·
51e6cf0
1
Parent(s):
f7eec8e
chore: refactor the md files to point at code src directory
Browse files- the search path config in mkdocs.yaml has a very obviously fake name
so the config is read ok (blank, or empty list seems to get into an
infinite loop)
- docs/fix_tabrender.md +1 -1
- docs/input_handling.md +1 -1
- docs/main.md +1 -1
- docs/obs_map.md +1 -1
- docs/st_logs.md +1 -1
- docs/whale_gallery.md +1 -1
- docs/whale_viewer.md +1 -1
- mkdocs.yaml +5 -2
docs/fix_tabrender.md
CHANGED
@@ -2,4 +2,4 @@ A js fix for certain UI elements, including maps, getting rendered into a
|
|
2 |
zero-sized frame by default. Here we resize it so it is visible once the tab is
|
3 |
clicked and no further interaction is required to see it.
|
4 |
|
5 |
-
:::
|
|
|
2 |
zero-sized frame by default. Here we resize it so it is visible once the tab is
|
3 |
clicked and no further interaction is required to see it.
|
4 |
|
5 |
+
::: src.fix_tabrender
|
docs/input_handling.md
CHANGED
@@ -5,4 +5,4 @@ This module focuses on image and metadata entry:
|
|
5 |
- a container class for an observation
|
6 |
|
7 |
|
8 |
-
:::
|
|
|
5 |
- a container class for an observation
|
6 |
|
7 |
|
8 |
+
::: src.input_handling
|
docs/main.md
CHANGED
@@ -7,4 +7,4 @@ The session state is used to retain values from one interaction to the next, sin
|
|
7 |
See streamlit [docs](https://docs.streamlit.io/develop/api-reference/caching-and-state/st.session_state).
|
8 |
|
9 |
|
10 |
-
:::
|
|
|
7 |
See streamlit [docs](https://docs.streamlit.io/develop/api-reference/caching-and-state/st.session_state).
|
8 |
|
9 |
|
10 |
+
::: src.entry_and_hotdog
|
docs/obs_map.md
CHANGED
@@ -4,4 +4,4 @@ Note: OSM, ESRI, and CartoDB map tiles are served without authentication/tokens,
|
|
4 |
and so render correctly on the huggingface deployment. The Stamen tiles render
|
5 |
on localhost but require a token to present on a 3rd-party site.
|
6 |
|
7 |
-
:::
|
|
|
4 |
and so render correctly on the huggingface deployment. The Stamen tiles render
|
5 |
on localhost but require a token to present on a 3rd-party site.
|
6 |
|
7 |
+
::: src.obs_map
|
docs/st_logs.md
CHANGED
@@ -3,5 +3,5 @@ This module provides utilities to incorporate a standard python logger within st
|
|
3 |
|
4 |
# Streamlit log handler
|
5 |
|
6 |
-
:::
|
7 |
|
|
|
3 |
|
4 |
# Streamlit log handler
|
5 |
|
6 |
+
::: src.st_logs
|
7 |
|
docs/whale_gallery.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1 |
This module provides a gallery of the whales and dolphins that the classifier
|
2 |
is trained on. It diplays the images and links to further info on the species.
|
3 |
|
4 |
-
:::
|
|
|
1 |
This module provides a gallery of the whales and dolphins that the classifier
|
2 |
is trained on. It diplays the images and links to further info on the species.
|
3 |
|
4 |
+
::: src.whale_gallery
|
docs/whale_viewer.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1 |
This module provides a streamlit rendering for the whales and dolphins that the classifier is aware of, and also holds the
|
2 |
metadata for them (images, class names that the classifier uses, and URLS for further information about each species).
|
3 |
|
4 |
-
:::
|
|
|
1 |
This module provides a streamlit rendering for the whales and dolphins that the classifier is aware of, and also holds the
|
2 |
metadata for them (images, class names that the classifier uses, and URLS for further information about each species).
|
3 |
|
4 |
+
::: src.whale_viewer
|
mkdocs.yaml
CHANGED
@@ -16,8 +16,11 @@ plugins:
|
|
16 |
- mkdocstrings:
|
17 |
default_handler: python
|
18 |
handlers:
|
19 |
-
python:
|
20 |
-
paths: [
|
|
|
|
|
|
|
21 |
|
22 |
|
23 |
nav:
|
|
|
16 |
- mkdocstrings:
|
17 |
default_handler: python
|
18 |
handlers:
|
19 |
+
python:
|
20 |
+
paths: [nonexistent_path_on_purpose]
|
21 |
+
|
22 |
+
# python:
|
23 |
+
#paths: [srcy]
|
24 |
|
25 |
|
26 |
nav:
|