Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only use pyi files for autoapi doc generation #9466

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

jepler
Copy link
Member

@jepler jepler commented Jul 26, 2024

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

@FoamyGuy
Copy link
Collaborator

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 board page. But I found the same when I tested #9431. I even went back to #9431 again today and did another local build and confirmed I do still see content on the board page with a build from that branch as well.

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

@jepler
Copy link
Member Author

jepler commented Jul 26, 2024

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.

@jepler jepler requested a review from FoamyGuy July 26, 2024 16:25
Copy link
Collaborator

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's see how the "real" build acts! Thanks for the fix

@tannewt tannewt merged commit 901dd22 into adafruit:9.1.x Jul 26, 2024
12 checks passed
@FoamyGuy
Copy link
Collaborator

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

@jepler jepler mentioned this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants