forked from micropython/micropython
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Fix autodoc in library doc builds #624
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
Comments
Just for clarification/get-out-in-front of questions: will these need PRs to the bundle repo, or will adabot pull them automagically? |
Just PRs to individual repos. ReadTheDocs is based on each repo so it'll pick them up once merged. They don't even need a release. |
This was referenced Feb 16, 2018
This was referenced Feb 16, 2018
This was referenced Feb 16, 2018
This was referenced Feb 21, 2018
adafruit/Adafruit_CircuitPython_APDS9960#8 is the last fix for this I believe. |
Belated close-n-thanks, @brentru!!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
These repos have docs that may technically pass but the autodoc portion fails. This is usually due to a library not being mocked out. To fix it, a line must be added to conf.py to tell sphinx to mock out specific modules. Here is the line from the latest cookicutter's conf.py:
Copy these four lines, uncomment the fourth and adjust the list until the sphinx build includes the autodocs.
The text was updated successfully, but these errors were encountered: