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.

Sign up for GitHub

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

Jump to bottom

Add missing files to API reference #149

Merged
merged 5 commits into from
Jan 14, 2022
Merged

Add missing files to API reference #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
78189d7
Add missing files to api.rst
tekktrik Jan 13, 2022
09ce803
Add adafruit_requests to mock imports
tekktrik Jan 13, 2022
afccfab
Add indent to Sphinx param line in docstring
tekktrik Jan 13, 2022
42dfe33
Add line after bullet list in module docstring
tekktrik Jan 13, 2022
50e2397
Add indent to line after bullet point
tekktrik Jan 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions adafruit_esp32spi/digitalio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
DigitalIO for ESP32 over SPI.

* Author(s): Brent Rubell, based on Adafruit_Blinka digitalio implementation
and bcm283x Pin implementation.
and bcm283x Pin implementation.

https://github.com/adafruit/Adafruit_Blinka/blob/master/src/adafruit_blinka/microcontroller/bcm283x/pin.py
https://github.com/adafruit/Adafruit_Blinka/blob/master/src/digitalio.py
"""
Expand Down Expand Up @@ -195,7 +196,7 @@ def drive_mode(self):
def drive_mode(self, mode):
"""Sets the pin drive mode.
:param DriveMode mode: Defines the drive mode when outputting digital values.
Either PUSH_PULL or OPEN_DRAIN
Either PUSH_PULL or OPEN_DRAIN
"""
if mode is DriveMode.OPEN_DRAIN:
raise NotImplementedError(
Expand Down
12 changes: 12 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,15 @@

.. automodule:: adafruit_esp32spi.adafruit_esp32spi_socket
:members:

.. automodule:: adafruit_esp32spi.adafruit_esp32spi_wifimanager
:members:

.. automodule:: adafruit_esp32spi.adafruit_esp32spi_wsgiserver
:members:

.. automodule:: adafruit_esp32spi.digitalio
:members:

.. automodule:: adafruit_esp32spi.PWMOut
:members:
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
# 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 = ["digitalio", "busio"]
autodoc_mock_imports = ["adafruit_requests"]


intersphinx_mapping = {
Expand Down