Add API documentation #456
Conversation
docs/api/advanced/index.rst
Outdated
| mcstatus.address | ||
| mcstatus.dns |
There was a problem hiding this comment.
Do we really want to make these a part of the public API? These are purely internal tools which don't really have anything to do with obtaining status of minecraft servers. I would rather avoid making these public as it forces us to keep them backwards compatible. I'd put these on the internal page instead.
There was a problem hiding this comment.
I thought that mcstatus.dns is a part of Public API, maybe I just remember #203 wrong. Although, in the #203 description, it's clearly mentioned that this is a part of Public API.
Fair, I might've originally intended it to be a part of the public API, however I'm not sure if it actually should be. I'd vote for moving it into the internal, and if someone really wants it they can still technically use it as an internal feature, without us guaranteeing backwards compatibility there.
There was a problem hiding this comment.
Removed Address from here in this force push.
There was a problem hiding this comment.
Let's also remove the dns module, as I said, it probably shouldn't be a part of the public API.
There was a problem hiding this comment.
I would like to hear @kevinkjt2000's mind also.
https://discord.com/channels/936788458939224094/938623566964981802/1061536418175918141
ItsDrike
added
area: documentation
PerchunPak
force-pushed
the
api-docs
branch
5 times, most recently
from
9a33ad9 to
7ac4014
Compare
|
Documentation build will be fixed after #458. |
Note that documentation in general is not finished. This just adds the skeleton for the API docs, I also didn't adapt docstrings for Sphinx style yet, it will be a separated PR.
To see the docs:
poetry install --with docscd docsmake html_build/html/index.htmlin your browser.I also used built-in Sphinx type hints support (see discussion in Discord) because the second variant was buggy. Although, I like the result.