Skip to content

Commit 7b11423

Browse files
committed
docs: enhance README and mkdocs with improved clarity and structure
1 parent ad3201b commit 7b11423

File tree

4 files changed

+66
-33
lines changed

4 files changed

+66
-33
lines changed

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,21 @@ We believe that powerful automation shouldn't require you to become a configurat
3333

3434
## What Makes Pydoll Special
3535

36-
**Genuine Simplicity**
37-
We don't want you wasting time configuring drivers or dealing with compatibility issues. With Pydoll, you install and you're ready to automate.
36+
**Genuine Simplicity**: We don't want you wasting time configuring drivers or dealing with compatibility issues. With Pydoll, you install and you're ready to automate.
3837

39-
**Truly Human Interactions**
40-
Our algorithms simulate real human behavior patterns - from timing between clicks to how the mouse moves across the screen.
38+
**Truly Human Interactions**: Our algorithms simulate real human behavior patterns - from timing between clicks to how the mouse moves across the screen.
4139

42-
**Native Async Performance**
43-
Built from the ground up with `asyncio`, Pydoll doesn't just support asynchronous operations - it was designed for them.
40+
**Native Async Performance**: Built from the ground up with `asyncio`, Pydoll doesn't just support asynchronous operations - it was designed for them.
4441

45-
**Integrated Intelligence**
46-
Automatic bypass of Cloudflare Turnstile and reCAPTCHA v3 captchas, without external services or complex configurations.
42+
**Integrated Intelligence**: Automatic bypass of Cloudflare Turnstile and reCAPTCHA v3 captchas, without external services or complex configurations.
4743

48-
**Powerful Network Monitoring**
49-
Intercept, modify, and analyze all network traffic with ease, giving you complete control over requests.
44+
**Powerful Network Monitoring**: Intercept, modify, and analyze all network traffic with ease, giving you complete control over requests.
5045

51-
**Event-Driven Architecture**
52-
React to page events, network requests, and user interactions in real-time.
46+
**Event-Driven Architecture**: React to page events, network requests, and user interactions in real-time.
5347

54-
**Intuitive Element Finding**
55-
Modern `find()` and `query()` methods that make sense and work as you'd expect.
48+
**Intuitive Element Finding**: Modern `find()` and `query()` methods that make sense and work as you'd expect.
5649

57-
**Robust Type Safety**
58-
Comprehensive type system for better IDE support and error prevention.
50+
**Robust Type Safety**: Comprehensive type system for better IDE support and error prevention.
5951

6052
## Installation
6153

mkdocs.yml

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Pydoll
1+
site_name: Pydoll - Async Web Automation Library
22
repo_url: https://github.com/autoscrape-labs/pydoll
33
repo_name: autoscrape-labs/pydoll
44

@@ -11,11 +11,43 @@ nav:
1111
- Chrome DevTools Protocol: deep-dive/cdp.md
1212
- The Connection Layer: deep-dive/connection-layer.md
1313
- The Browser Domain: deep-dive/browser-domain.md
14-
- The Page Domain: deep-dive/page-domain.md
14+
- The Tab Domain: deep-dive/tab-domain.md
1515
- The Find Elements Mixin: deep-dive/find-elements-mixin.md
1616
- The WebElement Domain: deep-dive/webelement-domain.md
1717
- The Event System: deep-dive/event-system.md
1818
- Network Capabilities: deep-dive/network-capabilities.md
19+
- API Reference:
20+
- Overview: api/index.md
21+
- Browser:
22+
- Chrome: api/browser/chrome.md
23+
- Edge: api/browser/edge.md
24+
- Options: api/browser/options.md
25+
- Tab: api/browser/tab.md
26+
- Managers: api/browser/managers.md
27+
- Elements:
28+
- WebElement: api/elements/web_element.md
29+
- Mixins: api/elements/mixins.md
30+
- Connection:
31+
- Connection Handler: api/connection/connection.md
32+
- Managers: api/connection/managers.md
33+
- Commands:
34+
- Overview: api/commands/index.md
35+
- Browser: api/commands/browser.md
36+
- DOM: api/commands/dom.md
37+
- Input: api/commands/input.md
38+
- Network: api/commands/network.md
39+
- Page: api/commands/page.md
40+
- Runtime: api/commands/runtime.md
41+
- Storage: api/commands/storage.md
42+
- Target: api/commands/target.md
43+
- Fetch: api/commands/fetch.md
44+
- Protocol:
45+
- Commands: api/protocol/commands.md
46+
- Events: api/protocol/events.md
47+
- Core:
48+
- Constants: api/core/constants.md
49+
- Exceptions: api/core/exceptions.md
50+
- Utils: api/core/utils.md
1951

2052
theme:
2153
name: material
@@ -40,8 +72,8 @@ theme:
4072
name: Light Mode
4173
icon:
4274
repo: fontawesome/brands/github
43-
logo: fontawesome/solid/bolt
44-
favicon: fontawesome/solid/bolt
75+
logo: material/lightning-bolt
76+
favicon: images/favicon.png
4577
features:
4678
- navigation.tabs
4779
- navigation.tabs.sticky
@@ -58,30 +90,22 @@ plugins:
5890
handlers:
5991
python:
6092
options:
61-
extensions:
62-
- griffe_typingdoc
6393
show_root_heading: true
6494
show_if_no_docstring: true
65-
preload_modules:
66-
- pydoll
67-
- pydoll.browser
68-
- pydoll.browser.chrome
69-
- pydoll.browser.options
70-
- pydoll.constants
71-
- pydoll.exceptions
72-
- pydoll.utils
7395
inherited_members: true
7496
members_order: source
7597
separate_signature: true
76-
unwrap_annotated: true
7798
filters:
7899
- '!^_'
100+
- '!^__'
79101
merge_init_into_class: true
80102
docstring_section_style: spacy
81103
signature_crossrefs: true
82104
show_symbol_type_heading: true
83105
show_symbol_type_toc: true
84-
106+
show_source: false
107+
show_bases: true
108+
heading_level: 1
85109

86110
extra_css:
87111
- stylesheets/termynal.css

poetry.lock

Lines changed: 16 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ websockets = "^13.1"
1414
aiohttp = "^3.9.5"
1515
aiofiles = "^23.2.1"
1616
bs4 = "^0.0.2"
17+
mkdocstrings = "^0.29.1"
1718

1819

1920
[tool.poetry.group.dev.dependencies]
@@ -27,6 +28,7 @@ mkdocs = "^1.6.1"
2728
mkdocs-material = "^9.6.11"
2829
pymdown-extensions = "^10.14.3"
2930
mkdocstrings = {extras = ["python"], version = "^0.29.1"}
31+
griffe-typingdoc = "^0.2.8"
3032

3133
[build-system]
3234
requires = ["poetry-core"]

0 commit comments

Comments
 (0)