linode_api4-python icon indicating copy to clipboard operation
linode_api4-python copied to clipboard

IPAddress.to Sphinx documentation doesn't link to anything

Open yoshizzle opened this issue 7 years ago • 2 comments

https://github.com/linode/python-linode-api/blob/dbcb8044099ae3ea1a6cdfebba6cfdadb428c6a6/linode/linode_client.py#L558

yoshizzle avatar Apr 16 '18 14:04 yoshizzle

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

andrewrabert avatar May 10 '18 04:05 andrewrabert

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

Dorthu avatar May 10 '18 11:05 Dorthu

Closing because this issue appears to be resolved. Feel free to @ me if it is still relevant.

lgarber-akamai avatar Mar 29 '23 18:03 lgarber-akamai