github/mealie
1
0
Fork 0
mirror of https://github.com/hay-kot/mealie.git synced 2025-07-07 05:22:18 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

dev: Improve Docs Generation (#4402)

Browse source 
Co-authored-by: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com>
This commit is contained in:
Michael Genson 2024-10-21 10:01:40 -05:00 • committed by GitHub
parent 674ad237f1
commit a7c8b33cca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 30 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

8
dev/code-generation/gen_docs_api.py
View file

@ -1,5 +1,8 @@
import json
from fastapi import FastAPI
from freezegun import freeze_time
from mealie.app import app
from mealie.core.config import determine_data_dir
@ -36,11 +39,12 @@ HTML_TEMPLATE = """<!-- Custom HTML site displayed as the Home chapter -->
HTML_PATH = DATA_DIR.parent.parent.joinpath("docs/docs/overrides/api.html")
def generate_api_docs(my_app):
def generate_api_docs(my_app: FastAPI):
with open(HTML_PATH, "w") as fd:
text = HTML_TEMPLATE.replace("MY_SPECIFIC_TEXT", json.dumps(my_app.openapi()))
fd.write(text)
if __name__ == "__main__":
generate_api_docs(app)
with freeze_time("2024-01-20T17:00:55Z"):
generate_api_docs(app)