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

"board" module still gets incorrect docs #9465

Closed
jepler opened this issue Jul 26, 2024 · 3 comments
Closed

"board" module still gets incorrect docs #9465

jepler opened this issue Jul 26, 2024 · 3 comments
Labels
board New board or update to a single board bug documentation
Milestone

Comments

@jepler
Copy link
Member

jepler commented Jul 26, 2024

CircuitPython version

9.1.x, main

Code/REPL

# readthedocs problem

Behavior

https://docs.circuitpython.org/en/latest/shared-bindings/board/index.html is empty, when it should have content

Description

During readthedocs, the empty __init__.py is used for generating the documentation of this module, rather than the __init__.pyi file:

[AutoAPI] Reading files... [ 47%] /home/docs/checkouts/readthedocs.org/user_builds/circuitpython/checkouts/9.1.x/circuitpython-stubs/board/__init__.py

Additional information

I thought I had fixed this in #9431 but apparently my fix was incorrect.

@jepler jepler added the bug label Jul 26, 2024
@tannewt tannewt added documentation board New board or update to a single board labels Jul 26, 2024
@tannewt tannewt added this to the 9.x.x milestone Jul 26, 2024
@jepler jepler closed this as completed in a055842 Jul 26, 2024
@jepler jepler reopened this Jul 26, 2024
@jepler
Copy link
Member Author

jepler commented Jul 26, 2024

It's still wrong in main branch now that it's been merged up: https://docs.circuitpython.org/en/latest/shared-bindings/board/index.html

I am perplexed but don't have any time to work on it now.

@jepler
Copy link
Member Author

jepler commented Jul 26, 2024

or maybe I needed to shift-reload. can someone else take a look and close if appropriate? I'm at my wits' end.

@FoamyGuy
Copy link
Collaborator

It appears to me that this is resolved now. I see the content inside the board module docs page on the currently live docs. I also saw an actions run that was previously failing due to this that was able to pass now.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board New board or update to a single board bug documentation
Projects
None yet
Development

No branches or pull requests

3 participants