[docs] Fix building the API reference.

pgjones / hypercorn

Hypercorn is an ASGI and WSGI Server based on Hyper libraries and inspired by Gunicorn.

MIT License

1.18k stars 105 forks source link

[docs] Fix building the API reference. #248

Open craigcitro opened 3 months ago

craigcitro commented 3 months ago

Why? docs are great

I noticed the docs have an empty API reference page; a quick check locally seems to confirm the problem is that the usual sphinx sys.path adjustments predate moving the source into src/hypercorn; this PR fixes the path accordingly.

(Happy to remove the ../ entry too, but wasn't sure if something else has quietly grown a dep on that in the docs.)

bmwant commented 2 months ago

@carlopires how to reproduce your issue? locally works for me with make html Screenshot 2024-08-31 at 4 35 50 PM

Although, I see that official RTD have this page missing https://hypercorn.readthedocs.io/en/latest/reference/api.html. But maybe it needs just another rebuild/republish?