Skip to content

Commit 0d6300c

Browse files
authored
Update documentation and prepare release (#135)
* Replace `extra-info` CSS class with `warning` to document exceptions raised * Move list of supported key types from usage page to documentation page * Briefly describe the source code organisation in the GitHub repository * Document new (more generous) behaviour of iterators over keys
1 parent 4207885 commit 0d6300c

File tree

9 files changed

+204
-143
lines changed

9 files changed

+204
-143
lines changed

docs/_static/custom.css

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
summary {
2+
cursor: pointer;
3+
font-style: italic;
4+
}
5+
6+
summary:hover {
7+
text-decoration: underline;
8+
}
9+
10+
.notice {
11+
background: rgba(39, 180, 166, 0.2);
12+
border-left: 4px solid rgb(39, 180, 166);
13+
border-radius: 6px;
14+
margin: 20px 0px 20px 0px;
15+
padding: 10px;
16+
}
17+
18+
.warning {
19+
background: rgba(175, 175, 95, 0.2);
20+
border-left: 4px solid rgb(175, 175, 95);
21+
border-radius: 6px;
22+
margin: 20px 0px 20px 0px;
23+
padding: 10px;
24+
}

docs/_static/styles.css

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
exclude_patterns = ["_build"]
1313

14-
html_css_files = ["styles.css"]
14+
html_css_files = ["custom.css"]
1515
html_logo = "logo.svg"
1616
html_static_path = ["_static"]
1717
html_theme = "furo"

0 commit comments

Comments
 (0)