Skip to content

Commit 625a774

Browse files
committed
#457 - Organize API reference better
1 parent c405d7c commit 625a774

File tree

10 files changed

+37
-83
lines changed

10 files changed

+37
-83
lines changed

docs/reference.md

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

docs/reference/client.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: thehive4py.client

docs/reference/endpoints.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<style>
2+
.md-typeset h5 {
3+
text-transform: none;
4+
}
5+
</style>
6+
::: thehive4py.endpoints
7+
options:
8+
show_submodules: true

docs/reference/errors.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: thehive4py.errors

docs/reference/helpers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: thehive4py.helpers

docs/reference/query.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: thehive4py.query
2+
options:
3+
show_submodules: true

docs/reference/session.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: thehive4py.session

docs/reference/types.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<style>
2+
.md-sidebar--secondary .md-nav__list .md-nav__list .md-nav__list .md-nav__list {
3+
display: none
4+
}
5+
.md-typeset h5 {
6+
text-transform: none;
7+
}
8+
</style>
9+
::: thehive4py.types
10+
options:
11+
show_submodules: true

docs/styles/extra.css

Lines changed: 2 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,5 @@
1-
:root {
1+
:root > * {
22
--md-primary-fg-color: #0049d4;
33
--md-accent-fg-color: #ffc72c;
4-
}
5-
6-
@keyframes pulse {
7-
0%, 100% {
8-
transform: scale(1);
9-
}
10-
50% {
11-
transform: scale(1.25);
12-
}
13-
}
14-
15-
16-
.coming-soon {
17-
color: var(--md-primary-fg-color);
18-
font-size: 1.5rem;
19-
font-weight: bold;
20-
transition: 0.75s;
21-
}
22-
23-
.coming-soon:hover{
24-
color: var(--md-accent-fg-color);
25-
transition: 0.75s;
26-
}
27-
28-
.upleftbee {
29-
rotate: -90deg;
30-
}
31-
32-
.upbee {
33-
rotate: -45deg;
34-
}
35-
36-
.uprightbee{
37-
rotate: 0deg;
38-
}
39-
40-
.downleftbee {
41-
rotate: 180deg;
42-
}
43-
44-
.downbee {
45-
rotate: 135deg;
46-
}
47-
48-
.downrightbee{
49-
rotate: 90deg;
50-
}
51-
52-
.yellowbee {
53-
color: var(--md-accent-fg-color)
54-
}
55-
56-
.bluebee {
57-
color: var(--md-primary-fg-color)
58-
}
59-
60-
.strangebee {
61-
animation: pulse 2s infinite;
62-
font-size: 1.5rem;
63-
vertical-align: top !important;
4+
--md-typeset-a-color: #2977ff;
645
}

mkdocs.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ nav:
77
- Client: examples/client.md
88
- Alert: examples/alert.md
99
- Case: examples/case.md
10-
- Reference: reference.md
10+
- Reference:
11+
- Client: reference/client.md
12+
- Endpoints: reference/endpoints.md
13+
- Errors: reference/errors.md
14+
- Query: reference/query.md
15+
- Session: reference/session.md
16+
- Types: reference/types.md
17+
- Helpers: reference/helpers.md
18+
1119
- Release Notes: release-notes.md
1220
theme:
1321
name: material

0 commit comments

Comments
 (0)