search

pallets / quart

An async Python micro framework for building web applications.
https://quart.palletsprojects.com
MIT License
3.02k stars 164 forks source link

Fix the reference docs #164

Closed pgjones closed 2 years ago

pgjones commented 2 years ago

They aren't being shown https://quart.palletsprojects.com/en/latest/reference/api.html

mmdbalkhi commented 2 years ago

hi @pgjones, can I work on it?

pgjones commented 2 years ago

Sure, this is the local command https://github.com/pallets/quart/blob/main/tox.ini#L32 - I think the only issue is that it isn't clear how to run that with Read the docs - or whether it should be run beforehand and committed to the repo.

I'm not sure what Flask does, but that might also be a solution.

mmdbalkhi commented 2 years ago

I'm not sure what Flask does, but that might also be a solution.

~I almost want to use Flask's texts, can I use them?~

The problem is probably because there used to be a file docs/reference/source, it was working locally, but the source/ is in Sphinx's gitignore and can't commit files in the docs/source/.

image

pgjones commented 2 years ago

I think sphinx-apidoc -e -f -o docs/reference/source/ src/quart/ creates the file from the current source code. If so I think we need a way to run this as part of the docs build.

Unless the issue is that that file needs to be created manually?

pgjones commented 2 years ago

Completed by 5597fc63ce889d8fc0354384d7ba7c9bde9d6794