linode_api4-python
linode_api4-python copied to clipboard
IPAddress.to Sphinx documentation doesn't link to anything
https://github.com/linode/python-linode-api/blob/dbcb8044099ae3ea1a6cdfebba6cfdadb428c6a6/linode/linode_client.py#L558
Should probably do two things:
- configure Sphinx to fail if any warnings are found. (http://www.sphinx-doc.org/en/stable/setuptools.html?highlight=warning-is-error#confval-warning-is-error)
- have a PR check fail when Sphinx docs cannot be built
This doesn't link to anything because I haven't gotten to finishing up these docs - nothing in linode.objects has a page in sphinx yet. Once the CLI is done and shipped I should have time to finish it up and remove the warning that the docs are incomplete
Closing because this issue appears to be resolved. Feel free to @ me if it is still relevant.