Circuitpython: Fix autodoc in library doc builds

Created on 15 Feb 2018  路  4Comments  路  Source: adafruit/circuitpython

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.

documentation good first issue

Most helpful comment

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.

All 4 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.

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tannewt picture tannewt  路  29Comments

No1089 picture No1089  路  31Comments

ladyada picture ladyada  路  31Comments

DWiskow picture DWiskow  路  29Comments

deshipu picture deshipu  路  44Comments