Only use pyi files for autoapi doc generation#9466
Conversation
|
Something strange seems to be going on inside of RTD. I'm not really sure how to check what the results of building the real docs inside of RTD are going to be. I tested this PR with a local build and it does show content on the I didn't know these existed, but I found just now you can see builds inside of RTD for each PR. Looking back at the RTD build for 9341 it does even show content on the board page correctly: https://circuitpython--9431.org.readthedocs.build/en/9431/shared-bindings/board/index.html The RTD preview build for 9466 does also show content on the board page: https://circuitpython--9466.org.readthedocs.build/en/9466/shared-bindings/board/index.html |
|
Yes, at some point we enabled RTD to build docs with each pull request. That's what I was hoping you'd look at when you reviewed it but I wasn't very specific I guess. |
FoamyGuy
left a comment
There was a problem hiding this comment.
To me it seems that looking at those isn't really showing us how it's going to turn out when it's merged and in the real docs though. The 9431 preview build looks correct: https://circuitpython--9431.org.readthedocs.build/en/9431/shared-bindings/board/index.html, as does the new one for 9466. But for some reason in the "latest" real build it's different than the PR preview ones in that it has the blank board page.
In my mind this does look good to merge.
But I'm not certain whether it will resolve the the issue in the real docs once they get built in RTD since there is seemingly some difference going on in that build compared to the PR previews and the local builds from just running make html in a local repo.
tannewt
left a comment
There was a problem hiding this comment.
Let's see how the "real" build acts! Thanks for the fix
|
The 9.1 docs are showing the content now on the board page 🎉 https://docs.circuitpython.org/en/9.1.x/shared-bindings/board/index.html |
Closes #9465
Please check the RTD html build when reviewing this bug! Last time we thought we fixed this, I think only local builds were checked (or something? not sure why the previous PR passed muster)
Will want to merge 9.1.x up to main after this. This is required for fixing the builds of various bundle libraries, fixing e.g., the failure seen in adafruit/Adafruit_CircuitPython_EMC2101#34