Fix URL in API consumer docs

[krysal]

Fixes

Prevents confusing errors like this reported in the Fixing WordPress Forums. The user was trying to register for a key following instructions but the API returned the following:

{
	"detail": "Method \"GET\" not allowed."
}

I tried to reproduce it and found this happens when missing the trailing slash in the endpoint.

Description

This PR fixes the docs URLs to prevent this from happening. Also includes some other minor docs changes to remove warnings when building sphinx docs (just sphinx-make).

Testing Instructions

just up and check http://localhost:50280/v1/#section/Register-and-Authenticate

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[github-actions]

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1002

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

[obulat]

Nice fix!
I wonder if replacing "Method GET not allowed" with "Only POST method allowed" would make it easier to understand the error message.

[AetherUnbound]

Great finds!

[krysal]

I wonder if replacing "Method GET not allowed" with "Only POST method allowed" would make it easier to understand the error message.

@obulat I'm not sure where that message is coming from, but I made the request with the POST method and still get that erroneous message, so the only fix I found at the moment is to fix the endpoint in the docs.

Thanks for the quick review both!