httpx/mkdocs.yml
Tom Christie 8cd952c88f
Docs restructuring. (#3049)
* Tweak docs layout

* Move client docs into folder

* Add clients/authentication section

* Client authentication docs

* Fix authentication example

* SSL Context

* Timeouts

* Event hooks

* Proxies, Transports

* Text encodings

* Resource limits

* 'Clients' -> 'Advanced'

* 'Clients' -> 'Advanced'

* Add client docs

---------

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>
2024-01-15 09:48:56 +00:00

60 lines
1.7 KiB
YAML

site_name: HTTPX
site_description: A next-generation HTTP client for Python.
site_url: https://www.python-httpx.org/
theme:
name: 'material'
palette:
- scheme: 'default'
media: '(prefers-color-scheme: light)'
toggle:
icon: 'material/lightbulb'
name: "Switch to dark mode"
- scheme: 'slate'
media: '(prefers-color-scheme: dark)'
primary: 'blue'
toggle:
icon: 'material/lightbulb-outline'
name: 'Switch to light mode'
repo_name: encode/httpx
repo_url: https://github.com/encode/httpx/
edit_uri: ""
nav:
- Introduction: 'index.md'
- QuickStart: 'quickstart.md'
- Advanced:
- Clients: 'advanced/clients.md'
- Authentication: 'advanced/authentication.md'
- SSL: 'advanced/ssl.md'
- Proxies: 'advanced/proxies.md'
- Timeouts: 'advanced/timeouts.md'
- Resource Limits: 'advanced/resource-limits.md'
- Event Hooks: 'advanced/event-hooks.md'
- Transports: 'advanced/transports.md'
- Text Encodings: 'advanced/text-encodings.md'
- Guides:
- Async Support: 'async.md'
- HTTP/2 Support: 'http2.md'
- Logging: 'logging.md'
- Requests Compatibility: 'compatibility.md'
- Troubleshooting: 'troubleshooting.md'
- API Reference:
- Developer Interface: 'api.md'
- Exceptions: 'exceptions.md'
- Environment Variables: 'environment_variables.md'
- Community:
- Third Party Packages: 'third_party_packages.md'
- Contributing: 'contributing.md'
- Code of Conduct: 'code_of_conduct.md'
markdown_extensions:
- admonition
- codehilite:
css_class: highlight
- mkautodoc
extra_css:
- css/custom.css