Skip to content

Commit 10def22

Browse files
committed
docs: add protocol documentation for browser, DOM, and fetch types
1 parent 0750d6b commit 10def22

29 files changed

+562
-306
lines changed

docs/api/browser/requests.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The main interface for making HTTP requests within the browser context.
2222
heading_level: 3
2323
group_by_category: true
2424
members_order: source
25+
filters:
26+
- "!^__"
2527

2628
## Response Class
2729

@@ -34,6 +36,8 @@ Represents the response from HTTP requests, providing a familiar interface simil
3436
heading_level: 3
3537
group_by_category: true
3638
members_order: source
39+
filters:
40+
- "!^__"
3741

3842
## Usage Examples
3943

docs/api/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,16 @@ The commands module provides low-level Chrome DevTools Protocol command implemen
3636
### Protocol Module
3737
The protocol module implements the Chrome DevTools Protocol commands and events.
3838

39-
- **[Commands](protocol/commands.md)** - CDP command implementations
40-
- **[Events](protocol/events.md)** - CDP event handling
39+
- **[Base Types](protocol/base.md)** - Base types for Chrome DevTools Protocol
40+
- **[Browser](protocol/browser.md)** - Browser domain commands and events
41+
- **[DOM](protocol/dom.md)** - DOM domain commands and events
42+
- **[Fetch](protocol/fetch.md)** - Fetch domain commands and events
43+
- **[Input](protocol/input.md)** - Input domain commands and events
44+
- **[Network](protocol/network.md)** - Network domain commands and events
45+
- **[Page](protocol/page.md)** - Page domain commands and events
46+
- **[Runtime](protocol/runtime.md)** - Runtime domain commands and events
47+
- **[Storage](protocol/storage.md)** - Storage domain commands and events
48+
- **[Target](protocol/target.md)** - Target domain commands and events
4149

4250
### Core Module
4351
The core module contains fundamental utilities, constants, and exceptions.

docs/api/protocol/base.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Protocol Base Types
2+
3+
Base types and structures for Chrome DevTools Protocol commands, responses, and events.
4+
5+
## Base Types
6+
7+
::: pydoll.protocol.base
8+
options:
9+
show_root_heading: true
10+
show_source: false
11+
heading_level: 3
12+
group_by_category: true
13+
members_order: source
14+
filters:
15+
- "!^__"

docs/api/protocol/browser.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Browser Protocol
2+
3+
Browser domain commands, events and types for Chrome DevTools Protocol.
4+
5+
## Methods
6+
7+
::: pydoll.protocol.browser.methods
8+
options:
9+
show_root_heading: true
10+
show_source: false
11+
heading_level: 2
12+
13+
## Events
14+
15+
::: pydoll.protocol.browser.events
16+
options:
17+
show_root_heading: true
18+
show_source: false
19+
heading_level: 2
20+
21+
## Types
22+
23+
::: pydoll.protocol.browser.types
24+
options:
25+
show_root_heading: true
26+
show_source: false
27+
heading_level: 2

docs/api/protocol/commands.md

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

docs/api/protocol/dom.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# DOM Protocol
2+
3+
DOM domain commands and events for Chrome DevTools Protocol.
4+
5+
## Methods
6+
7+
::: pydoll.protocol.dom.methods
8+
options:
9+
show_root_heading: true
10+
show_source: false
11+
heading_level: 2
12+
13+
## Events
14+
15+
::: pydoll.protocol.dom.events
16+
options:
17+
show_root_heading: true
18+
show_source: false
19+
heading_level: 2
20+
21+
## Types
22+
23+
::: pydoll.protocol.dom.types
24+
options:
25+
show_root_heading: true
26+
show_source: false
27+
heading_level: 2

docs/api/protocol/events.md

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

docs/api/protocol/fetch.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Fetch Protocol
2+
3+
Fetch domain commands, events and types for Chrome DevTools Protocol.
4+
5+
## Methods
6+
7+
::: pydoll.protocol.fetch.methods
8+
options:
9+
show_root_heading: true
10+
show_source: false
11+
heading_level: 2
12+
13+
## Events
14+
15+
::: pydoll.protocol.fetch.events
16+
options:
17+
show_root_heading: true
18+
show_source: false
19+
heading_level: 2
20+
21+
## Types
22+
23+
::: pydoll.protocol.fetch.types
24+
options:
25+
show_root_heading: true
26+
show_source: false
27+
heading_level: 2

docs/api/protocol/input.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Input Protocol
2+
3+
Input domain commands, events and types for Chrome DevTools Protocol.
4+
5+
## Methods
6+
7+
::: pydoll.protocol.input.methods
8+
options:
9+
show_root_heading: true
10+
show_source: false
11+
heading_level: 2
12+
13+
## Events
14+
15+
::: pydoll.protocol.input.events
16+
options:
17+
show_root_heading: true
18+
show_source: false
19+
heading_level: 2
20+
21+
## Types
22+
23+
::: pydoll.protocol.input.types
24+
options:
25+
show_root_heading: true
26+
show_source: false
27+
heading_level: 2

docs/api/protocol/network.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Network Protocol
2+
3+
Network domain commands and events for Chrome DevTools Protocol.
4+
5+
## Methods
6+
7+
::: pydoll.protocol.network.methods
8+
options:
9+
show_root_heading: false
10+
show_source: false
11+
heading_level: 2
12+
13+
## Events
14+
15+
::: pydoll.protocol.network.events
16+
options:
17+
show_root_heading: false
18+
show_source: false
19+
heading_level: 2
20+
21+
## Types
22+
23+
::: pydoll.protocol.network.types
24+
options:
25+
show_root_heading: false
26+
show_source: false
27+
heading_level: 2

0 commit comments

Comments
 (0)