python-hyper/hyperlink

The hosted documentation includes no API documentation

exarkun opened this issue · 3 comments

exarkun commented

The API documentation page is essentially empty of API documentation:

https://hyperlink.readthedocs.io/en/latest/api.html

mahmoud commented

Haha, I suspected this was more than a scathing review. I think possibly the recent src nesting is tripping Sphinx up. I'll look into it, maybe @wsanchez beats me to it though.

mahmoud commented

OK there was a checkbox under "Advanced Settings" called "Install project" which was necessary for Sphinx to autodoc under the new src/ scheme. Seems to be up. Thanks for the report!

  • 👍1
wsanchez commented

Huh. I have very little clue about Sphinx, because I've never figured out how to set it up properly. Sorry about the breakage there.