Skip to content

Revamp the website guides #549

@0x676e67

Description

@0x676e67

Refine documentation at https://python.wreq.org/. The current guides lack sufficient depth for beginners. We aim to categorize tutorials by topic and implement a progressive learning path. Contributions to enhance clarity and structure are highly welcome.

docs_dir: source
extra:
version:
provider: mike
theme:
name: material
font:
code: Roboto Mono
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
features:
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- header.autohide
- toc.follow
- toc.integrate
- navigation.path
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.indexes
- navigation.instant
- navigation.instant.progress
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [../python]
options:
extensions:
- unpack_typeddict
- dataclasses
docstring_style: auto
show_source: true
show_root_heading: true
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
show_bases: true
show_signature: true
separate_signature: true
allow_inspection: false
find_stubs_package: true
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- attr_list
- md_in_html
- pymdownx.emoji
- pymdownx.tasklist
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
nav:
- Getting Started:
- Introduction: getting-started/introduction.md
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Guides:
- Basic Usage: guide/basic.md
- Emulation: guide/emulation.md
- Authentication: guide/auth.md
- WebSocket: guide/websocket.md
- Proxy: guide/proxy.md
- Redirect & Errors: guide/redirect-errors.md
- Advanced Features: guide/advanced.md
- Blocking/Sync API: guide/blocking.md
- API Reference:
- Modules:
- wreq: api/wreq.md
- wreq.blocking: api/blocking.md
- wreq.header: api/header.md
- wreq.cookie: api/cookie.md
- wreq.exceptions: api/exceptions.md
- wreq.emulation: api/emulation.md
- wreq.http1: api/http1.md
- wreq.http2: api/http2.md
- wreq.tls: api/tls.md
- wreq.dns: api/dns.md
- wreq.proxy: api/proxy.md
- wreq.redirect: api/redirect.md
- Sponsors: sponsors.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    E-easyEffort: Easy! Start here :DE-pr-welcomeThe feature is welcome to be added, instruction should be found in the issue.documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions