Skip to content

Commit f2720b9

Browse files
RobertoPrevatoyasamokaSerTetora
authored
Improvements, add past contributors info (#3)
* Some improvements * Credit @yasamoka * Credit @SerTetora --------- Co-authored-by: Ramzi Sabra <yasamoka@gmail.com> Co-authored-by: Serhii Tetora <95703687+SerTetora@users.noreply.github.com>
1 parent 983fe25 commit f2720b9

File tree

7 files changed

+24
-40
lines changed

7 files changed

+24
-40
lines changed

blacksheep/docs/behind-proxies.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ sequenceDiagram
108108
Proxy-->>User: HTTP 404 Not Found
109109
```
110110

111-
/// details | The example of API Gateway
111+
/// details | The example of API Gateways
112112
type: info
113113

114114
API Gateways like [AWS API Gateway](https://docs.aws.amazon.com/prescriptive-guidance/latest/cloud-design-patterns/api-routing-path.html)
@@ -132,13 +132,13 @@ implementing interactive sign-in.
132132
(applying URL rewrite).
133133
- The second approach involves configuring a prefix in the application router
134134
to globally change the prefix of all request handlers. The global prefix can
135-
also be set using the environment variable `APP_ROUTE_PREFIX`. This method
136-
assumes that modifying the path handled by the web server is desirable to
137-
align it with the path handled by the HTTP proxy server, and it is ideal
138-
when using URL rewrite is not easy.
135+
be set when instantiating the `Router` or using the environment variable
136+
`APP_ROUTE_PREFIX`. This method assumes that modifying the path handled by
137+
the web server is desirable to align it with the path handled by the HTTP
138+
proxy server, and it is ideal when applying URL rewrite is not easy.
139139

140140
For both options, `BlackSheep` handles the information provided by `root_path`
141-
or the application router prefix in some specific ways.
141+
and the application router prefix in some specific ways.
142142
For example, the `get_absolute_url_to_path` defined in `blacksheep.messages`
143143
will handle the information and return an absolute URL to the server
144144
according to both scenarios.

blacksheep/docs/client.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ BlackSheep includes an implementation of HTTP Client for HTTP 1.1.
44

55
## Client features
66

7-
- HTTP connection pooling
8-
- User-friendly handling of SSL contexts (safe by default)
9-
- Support for client side middlewares
7+
- HTTP connection pooling.
8+
- User-friendly handling of SSL contexts (safe by default).
9+
- Support for client side middlewares.
1010
- Automatic handling of redirects (can be disabled, validates circular
1111
redirects and maximum number of redirects - redirects to URN are simply
12-
returned to code using the client)
12+
returned to code using the client).
1313
- Automatic handling of cookies (can be disabled, `Set-Cookie` and `Cookie`
14-
headers)
14+
headers).
1515

1616
**Example:**
17+
1718
```python
1819
import asyncio
1920
from blacksheep.client import ClientSession
@@ -30,7 +31,6 @@ async def client_example(loop):
3031

3132
loop = asyncio.get_event_loop()
3233
loop.run_until_complete(client_example(loop))
33-
3434
```
3535

3636
## HTTP Connection pooling
@@ -59,7 +59,6 @@ design pattern, and this is supported in BlackSheep.
5959

6060
```python
6161
async def client_example_middleware(request, next_handler):
62-
6362
# do something before the request is sent
6463
response = await next_handler(request)
6564

@@ -86,7 +85,6 @@ if it was created for the client.
8685
It is recommended to instantiate a single instance of HTTP client and
8786
register it as a service of the application, using the `@app.lifespan` method:
8887

89-
```python
9088
```python
9189
from blacksheep import Application
9290
from blacksheep.client.session import ClientSession
@@ -111,5 +109,5 @@ async def home(http_client: ClientSession):
111109
```
112110

113111
When following this approach, the HTTP client can be automatically injected
114-
into request handlers, and services that need it, and is automatically disposed
112+
into request handlers and services that need it, and is automatically disposed
115113
of when the application is stopped.

blacksheep/docs/css/extra.css

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,6 @@ html {
22
overflow-y: scroll;
33
}
44

5-
/* For large screens, make better use of the horizontal space */
6-
@media screen and (min-width: 2000px) {
7-
.md-grid {
8-
max-width: 98%;
9-
}
10-
11-
.md-sidebar {
12-
width: auto;
13-
min-width: 15%;
14-
}
15-
16-
body.fullscreen #fullscreen-form label {
17-
display: none !important;
18-
}
19-
}
20-
215
@media screen and (min-width: 1000px) {
226
html.fullscreen {
237
.md-grid {

blacksheep/mkdocs.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,7 @@ extra_javascript:
9090

9191
plugins:
9292
- search
93-
- neoteroi.contribs:
94-
contributors:
95-
- email: roberto.prevato@gmail.com
96-
image: https://avatars.githubusercontent.com/u/2576032?s=400&u=d8d880e8ed05bb170877dd3d561d8301c4beeeed&v=4
93+
- neoteroi.contribs
9794

9895
markdown_extensions:
9996
- admonition

mkdocs-plugins/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# MkDocs Plugins docs 📜
22

33
[www.neoteroi.dev](https://www.neoteroi.dev/mkdocs-plugins/).
4+
5+
## Additional contributors
6+
7+
This section lists contributors from the [previous repository](https://github.com/Neoteroi/mkdocs-plugins-docs),
8+
before the code was transferred here.
9+
10+
- [@SerTetora](https://github.com/Neoteroi/mkdocs-plugins-docs/commits?author=SerTetora)
11+
- [@yasamoka](https://github.com/Neoteroi/mkdocs-plugins-docs/commits?author=yasamoka)

mkdocs-plugins/docs/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
## The project's home
66
The project source code is in [GitHub](https://github.com/Neoteroi/mkdocs-plugins).
77

8-
The documentation source code is in [GitHub](https://github.com/Neoteroi/mkdocs-plugins-docs).
8+
The documentation source code is here in [GitHub](https://github.com/Neoteroi/neoteroi.github.io).

mkdocs-plugins/mkdocs.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,7 @@ extra_css:
4848

4949
plugins:
5050
- search
51-
- neoteroi.contribs:
52-
contributors:
53-
- email: roberto.prevato@gmail.com
54-
image: https://avatars.githubusercontent.com/u/2576032?s=400&u=d8d880e8ed05bb170877dd3d561d8301c4beeeed&v=4
51+
- neoteroi.contribs
5552

5653
markdown_extensions:
5754
- admonition

0 commit comments

Comments
 (0)