#1856 Auto-document the REST API
Closed by pingou. Opened by jcline.
jcline/pagure autodoc-api  into  master

Download 1856.patch

Is this packaged in Fedora and epel? a quick dnf search doesn't seem to find it :s

Yep, I remember having trouble finding it as well, but it's https://apps.fedoraproject.org/packages/python-sphinxcontrib-httpdomain

Cool, thanks :)

rebased

Thanks to your info I could test it locally but it looks a little odd and raises a bunch of error/warning during the build.

Do we want to fix them?

rebased

I started by converting one dockblock in a follow-up commit here. If you're okay with it, I'll file an issue (with a link to the docblock I did here and the httpdomain documentation) to convert the rest of the docs.

I think fixing all the docs to look nice is going to be a fairly large task (a lot are missing the standard sphinx :param <thing: stuff that is used by autoflask to fill in the url parameters) that would be best to chip away at.

No idea if this is doable, but do you think we could put APP_URL in here?

I'm pretty sure it's not doable without writing a sphinx extension to execute some string as Python, sadly

I liked the idea of this PR but we never went all the way through with it and it's been stale for a year now.

So I am going to close it while trying to keep in mind its goal and maybe we can get it properly fixed in the future :)

Thanks for your work and ideas, they are always appreciated!

Pull-Request has been closed by pingou

Metadata