Skip to content

Commit

Permalink
docs: add black to allow docs formatting (#2818)
Browse files Browse the repository at this point in the history
* docs: add `black` to allow docs formatting

* Only install black on Python >= 3.9
  • Loading branch information
Kludex authored Dec 28, 2024
1 parent 43ca933 commit 4c257e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/applications.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@

??? abstract "API Reference"
::: starlette.applications.Starlette
options:
parameter_headings: false
show_root_heading: true
heading_level: 3
filters:
- "__init__"

Starlette includes an application class `Starlette` that nicely ties together all of
its other functionality.

Expand Down Expand Up @@ -45,15 +54,6 @@ routes = [
app = Starlette(debug=True, routes=routes, lifespan=lifespan)
```

??? abstract "API Reference"
::: starlette.applications.Starlette
options:
parameter_headings: false
show_root_heading: true
heading_level: 3
filters:
- "__init__"

### Storing state on the app instance

You can store arbitrary extra state on the application instance, using the
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ pytest==8.3.4
trio==0.27.0

# Documentation
black==24.10.0; python_version >= "3.9"
mkdocs==1.6.1
mkdocs-material==9.5.47
mkdocstrings-python<1.12.0; python_version < "3.9"
Expand Down

0 comments on commit 4c257e3

Please sign in to comment.