Added link to the REST API docs
This commit is contained in:
@@ -9,6 +9,8 @@ these services can e.g. list available spools, report filament consumption, etc.
|
|||||||
|
|
||||||
Currently, it has no client GUI, and only operates using HTTP REST commands.
|
Currently, it has no client GUI, and only operates using HTTP REST commands.
|
||||||
|
|
||||||
|
REST API: https://donkie.github.io/Spoolman/
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
The data can be stored using any async SQLAlchemy supported database:
|
The data can be stored using any async SQLAlchemy supported database:
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Functions for generating documentation."""
|
"""Functions for generating documentation."""
|
||||||
|
|
||||||
from contextlib import suppress
|
|
||||||
import json
|
import json
|
||||||
|
from contextlib import suppress
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
@@ -36,7 +36,6 @@ def generate_openapi(app: FastAPI) -> dict[str, Any]:
|
|||||||
|
|
||||||
def generate_docs() -> None:
|
def generate_docs() -> None:
|
||||||
"""Generate documentation for this service in the docs/ directory."""
|
"""Generate documentation for this service in the docs/ directory."""
|
||||||
|
|
||||||
with suppress(FileExistsError):
|
with suppress(FileExistsError):
|
||||||
Path("docs").mkdir()
|
Path("docs").mkdir()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user