Skip to content

Docs restructuring. - #3049

Merged
lovelydinosaur merged 16 commits into
masterfrom
docs-incremental
Jan 15, 2024
Merged

lovelydinosaur merged 16 commits into
masterfrom
docs-incremental

Conversation

@lovelydinosaur

Copy link
Copy Markdown
Member

Working through the docs refresh mentioned in #947 (comment).

This PR starts with some restructuring, without adding/removing/changing the content...

Before:

before

After:

after

@lovelydinosaur
lovelydinosaur requested a review from a team January 11, 2024 13:09
@lovelydinosaur lovelydinosaur added the 1.0 proposal Pull requests proposing 1.0 API changes label Jan 12, 2024
@lovelydinosaur lovelydinosaur mentioned this pull request Jan 12, 2024
@zanieb

zanieb commented Jan 13, 2024

Copy link
Copy Markdown
Contributor

This is a great improvement!

Comment thread docs/advanced/clients.md Outdated
Comment thread docs/advanced/clients.md Outdated
@lovelydinosaur

Copy link
Copy Markdown
Member Author

Thanks team. 馃

@lovelydinosaur
lovelydinosaur merged commit 8cd952c into master Jan 15, 2024
@lovelydinosaur
lovelydinosaur deleted the docs-incremental branch January 15, 2024 09:48
@karpetrosyan

Copy link
Copy Markdown
Contributor

I have found an issue when testing this locally.

Mkdocs says

WARNING -  Doc file 'index.md' contains a relative link 'advanced.md#calling-into-python-web-apps', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'index.md' contains a relative link 'advanced.md', but the target is not found among documentation files.
WARNING -  Doc file 'async.md' contains a relative link './advanced.md#request-instances', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'compatibility.md' contains a relative link 'advanced.md#mounting-transports', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'compatibility.md' contains a relative link 'advanced.md#request-instances', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'compatibility.md' contains a relative link 'advanced.md#client-instances', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'compatibility.md' contains a relative link 'advanced.md#custom-transports', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'environment_variables.md' contains a relative link 'advanced.md#http-proxying', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'quickstart.md' contains a relative link 'advanced.md#fine-tuning-the-configuration', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'third_party_packages.md' contains a relative link 'advanced.md#customizing-authentication', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'third_party_packages.md' contains a relative link 'advanced.md#custom-transports', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'troubleshooting.md' contains a relative link 'advanced.md#example', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'troubleshooting.md' contains a relative link 'advanced.md#forward-vs-tunnel', but the target 'advanced.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'quickstart.md', but the target 'advanced/quickstart.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'http2.md', but the target 'advanced/http2.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'quickstart.md', but the target 'advanced/quickstart.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'api.md#client', but the target 'advanced/api.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'api.md#request', but the target 'advanced/api.md' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'img/tqdm-progress.gif', but the target 'advanced/img/tqdm-progress.gif' is not found among documentation files.
WARNING -  Doc file 'advanced/clients.md' contains a relative link 'quickstart.md#sending-multipart-file-uploads', but the target 'advanced/quickstart.md' is not found among documentation files.
WARNING -  Doc file 'advanced/proxies.md' contains a relative link 'troubleshooting.md#proxies', but the target 'advanced/troubleshooting.md' is not found among documentation files.
WARNING -  Doc file 'advanced/transports.md' contains a relative link 'environment_variables.md#http_proxy-https_proxy-all_proxy', but the target 'advanced/environment_variables.md' is not found among
           documentation files.

I will open a pull request that resolves this

@Kludex

Kludex commented Jan 15, 2024

Copy link
Copy Markdown
Contributor

You can enforce warnings as errors on mkdocs - may be a good idea based on the above.

shepilov-vladislav pushed a commit to shepilov-vladislav/httpx that referenced this pull request Mar 28, 2024
* 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>
samclearman pushed a commit to titanmsp/httpx that referenced this pull request Apr 26, 2025
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.0 proposal Pull requests proposing 1.0 API changes

Development

Successfully merging this pull request may close these issues.

4 participants