Skip to content

Commit 287525e

Browse files
committed
websocket doc in progress
1 parent 432b32a commit 287525e

File tree

4 files changed

+7
-9
lines changed

4 files changed

+7
-9
lines changed

docs/templating/staticfiles.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ The path can be modified by providing a new value for the `STATIC_MOUNT_PATH` co
1010

1111
1. In your config file, define `STATIC_MOUNT_PATH`, for example:
1212
```python
13-
14-
class Config:
13+
class Config:
1514
STATIC_MOUNT_PATH = '/static'
1615
```
1716

@@ -38,19 +37,19 @@ This allows us to keep all of the static files related to the dogs module organi
3837
Next, we tell `DogModule` about our static folder.
3938

4039
```python
41-
# project_name/apps/dogs/module.py
40+
# project_name/apps/car/module.py
4241

4342
from ellar.common import Module
4443
from ellar.core import ModuleBase
4544
from ellar.di import Container
4645

47-
from .controllers import DogsController
46+
from .controllers import CarController
4847

4948

5049
@Module(
51-
controllers=[DogsController], static_folder='my_static'
50+
controllers=[CarController], static_folder='my_static'
5251
)
53-
class DogsModule(ModuleBase):
52+
class CarModule(ModuleBase):
5453
def register_providers(self, container: Container) -> None:
5554
# for more complicated provider registrations
5655
# container.register_instance(...)
@@ -64,7 +63,7 @@ it is also possible to manually specify additional static directories that are n
6463
These variables allow for even more flexibility in organizing and managing static files in a project.
6564
These directories will be served by the StaticFiles ASGI class along with the module-scoped static files.
6665

67-
### `STATIC_DIRECTORIES`
66+
### **`STATIC_DIRECTORIES`**
6867
`STATIC_DIRECTORIES` variable is a list of directories within the project that contain static files.
6968
These directories are not necessarily scoped to a specific module and can be used to serve static files from any location within the project.
7069
These directories can be added to the `STATIC_DIRECTORIES` list in the application's configuration.
@@ -73,7 +72,7 @@ These directories can be added to the `STATIC_DIRECTORIES` list in the applicati
7372
STATIC_DIRECTORIES = ['project_name/static-files', 'project_name/path/to/static/files']
7473
```
7574

76-
### `STATIC_FOLDER_PACKAGES`
75+
### **`STATIC_FOLDER_PACKAGES`**
7776
`STATIC_FOLDER_PACKAGES` variable is a list of tuples that contain python packages that hold some static files.
7877
These packages should have a `static` folder and the **package name** should be passed as tuple `(package_name, package_path)`,
7978
**package_path** is the relative path of static folder.

docs/websockets.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/websockets/index.md

Whitespace-only changes.

docs/websockets/socketio.md

Whitespace-only changes.

0 commit comments

Comments
 (0)