Skip to content

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

Closed
38 tasks done
tannewt opened this issue Feb 15, 2018 · 4 comments
Closed
38 tasks done

Fix autodoc in library doc builds #624

tannewt opened this issue Feb 15, 2018 · 4 comments

Comments

@tannewt
Copy link
Member

tannewt commented Feb 15, 2018

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:

# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["adafruit_bus_device", "micropython"]

Copy these four lines, uncomment the fourth and adjust the list until the sphinx build includes the autodocs.

@sommersoft
Copy link

Just for clarification/get-out-in-front of questions: will these need PRs to the bundle repo, or will adabot pull them automagically?

@tannewt
Copy link
Member Author

tannewt commented Feb 16, 2018

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.

@brentru brentru self-assigned this Feb 16, 2018
@tannewt
Copy link
Member Author

tannewt commented Mar 19, 2018

adafruit/Adafruit_CircuitPython_APDS9960#8 is the last fix for this I believe.

@sommersoft
Copy link

Belated close-n-thanks, @brentru!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants