[docs] Fix building the API reference. #248
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.)
|
@carlopires how to reproduce your issue? locally works for me with Although, I see that official RTD have this page missing https://hypercorn.readthedocs.io/en/latest/reference/api.html. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.pathadjustments predate moving the source intosrc/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.)