Added link to the REST API docs

This commit is contained in:
Donkie
2023-04-03 19:29:51 +02:00
parent a6f872bf69
commit ada139844a
2 changed files with 22 additions and 21 deletions

View File

@@ -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.
REST API: https://donkie.github.io/Spoolman/
## Prerequisites
The data can be stored using any async SQLAlchemy supported database:

View File

@@ -1,7 +1,7 @@
"""Functions for generating documentation."""
from contextlib import suppress
import json
from contextlib import suppress
from pathlib import Path
from typing import Any
@@ -36,7 +36,6 @@ def generate_openapi(app: FastAPI) -> dict[str, Any]:
def generate_docs() -> None:
"""Generate documentation for this service in the docs/ directory."""
with suppress(FileExistsError):
Path("docs").mkdir()