Skip to content

Commit 469a50d

Browse files
committed
docs: embed streamlit operation matrix app to docs
1 parent f49e429 commit 469a50d

File tree

6 files changed

+24
-99
lines changed

6 files changed

+24
-99
lines changed

.streamlit/config.toml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[browser]
2+
gatherUsageStats = false
3+
4+
[theme]
5+
base = "dark"

docs/backend_info_app.py docs/backends/app/backend_info_app.py

+1-11
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,7 @@ def get_selected_operation_categories():
129129
.T
130130
)
131131

132-
table = pd.concat(
133-
[
134-
coverage,
135-
df.replace(
136-
{
137-
True: "✔️",
138-
False: "✖",
139-
}
140-
),
141-
]
142-
)
132+
table = pd.concat([coverage, df.replace({True: "✔", False: "🚫"})])
143133
st.table(table)
144134
else:
145135
st.write("No data")
File renamed without changes.

docs/backends/support_matrix.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,14 @@ Backends are shown in descending order of the number of supported operations.
99

1010
!!! tip "Backends with low coverage are good places to start contributing!"
1111

12-
Each backend implements operations differently, but this is usually very similar
13-
to other backends.
14-
If you want to start contributing to ibis, it's a good idea to start by adding missing operations
15-
to backends that have low operation coverage.
16-
17-
## Core Operations
18-
19-
{{ read_csv("docs/backends/core_support_matrix.csv") }}
20-
21-
## Geospatial Operations
22-
23-
{{ read_csv("docs/backends/geospatial_support_matrix.csv") }}
12+
Each backend implements operations differently, but this is usually very
13+
similar to other backends. If you want to start contributing to ibis, it's
14+
a good idea to start by adding missing operations to backends that have low
15+
operation coverage.
16+
17+
<div class="streamlit-app">
18+
<iframe id="streamlit-app" src="https://ibis-project.streamlit.app/?embedded=true"></iframe>
19+
</div>
2420

2521
## Raw Data
2622

docs/stylesheets/extra.css

+8-75
Original file line numberDiff line numberDiff line change
@@ -39,84 +39,17 @@
3939
text-align: center;
4040
}
4141

42-
.support-matrix .md-typeset__table {
43-
display: table;
44-
min-width: 100%;
45-
}
46-
47-
.support-matrix .md-typeset table:not([class]) {
48-
display: table;
42+
.streamlit-app {
43+
text-align: center;
44+
height: 1000px;
4945
min-width: 100%;
50-
}
51-
52-
body
53-
> div.md-container
54-
> main
55-
> div
56-
> div.md-content
57-
> article
58-
> div.md-typeset__scrollwrap
59-
> div
60-
> table
61-
> thead
62-
> tr
63-
> th:nth-child(1) {
64-
min-width: 9.8rem;
65-
}
66-
body
67-
> div.md-container
68-
> main
69-
> div
70-
> div.md-content
71-
> article
72-
> div.md-typeset__scrollwrap {
7346
overflow-y: auto;
74-
height: 750px;
75-
}
76-
77-
body
78-
> div.md-container
79-
> main
80-
> div
81-
> div.md-content
82-
> article
83-
> div.md-typeset__scrollwrap
84-
> div
85-
> table {
8647
display: table;
8748
}
8849

89-
body
90-
> div.md-container
91-
> main
92-
> div
93-
> div.md-content
94-
> article
95-
> div.md-typeset__scrollwrap
96-
> div
97-
> table
98-
> thead {
99-
position: sticky;
100-
top: 0;
101-
z-index: 2;
102-
background-color: black;
103-
}
104-
105-
body
106-
> div.md-container
107-
> main
108-
> div
109-
> div.md-content
110-
> article
111-
> div.md-typeset__scrollwrap
112-
> div
113-
> table
114-
> tbody
115-
> tr
116-
> td:nth-of-type(1) {
117-
position: sticky;
118-
left: 0;
119-
z-index: 1;
120-
background-color: black;
121-
text-align: right;
50+
#streamlit-app {
51+
height: 100%;
52+
width: 100%;
53+
border: none;
54+
overflow: hidden;
12255
}

mkdocs.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ plugins:
4040
- exclude:
4141
glob:
4242
- backends/template.md
43-
- backends/support_matrix.csv
43+
- backends/*_support_matrix.csv
44+
- backends/app/*
4445
- CONTRIBUTING.md
4546
- gen-files:
4647
scripts:

0 commit comments

Comments
 (0)