app

api.app.app = FastAPI() module-attribute

api.app.mkdocs(request) async

Response de mkdocs site, from result of build. ONLY ENABLED IN DEV MODE.

Parameters:

Name	Type	Description	Default
request	Request	Fastapi Request	required

Returns:

Name	Type	Description
HTMLResponse	HTMLResponse	Mkdocs static site from documentation/site

Source code in api/app.py

@app.get('/', status_code=HTTPStatus.OK, response_class=HTMLResponse)
async def mkdocs(request: Request) -> HTMLResponse:
	"""
	Response de mkdocs site, from result of build.
	ONLY ENABLED IN DEV MODE.

	Args:
			request (Request): Fastapi Request

	Returns:
			HTMLResponse: Mkdocs static site from documentation/site

	"""
	return templates.TemplateResponse(name='index.html', request=request)