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

exclude circuitpython-stubs when building docs #9431

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

jepler
Copy link
Member

@jepler jepler commented Jul 15, 2024

Since 798e38e an empty board/__init__.py is created inside the stubs directory and sphinx uses this in lieu of the autodoc generated file from shared-bindings.

We don't intend to build docs from files in these paths, so just prune them.

Since 798e38e an empty
`board/__init__.py` is created inside the stubs directory and sphinx
uses this in lieu of the autodoc generated file from shared-bindings.

We don't intend to build docs from files in these paths, so just prune
them.
@jepler jepler requested a review from FoamyGuy July 15, 2024 22:01
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.

I confirmed in a local build with this branch that the content has returned to the board module docs page.

Thanks for the fix @jepler!

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.

Thanks!

@tannewt tannewt merged commit 2f62612 into adafruit:main Jul 16, 2024
12 checks passed
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