8000 fixing docs API section and resolve sphinx errors to get docs rendering by FoamyGuy · Pull Request #33 · adafruit/Adafruit_CircuitPython_ATECC · GitHub
[go: up one dir, main page]

Skip to content

fixing docs API section and resolve sphinx errors to get docs rendering #33

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

Merged
merged 1 commit into from
May 1, 2023

Conversation

FoamyGuy
Copy link
Contributor
@FoamyGuy FoamyGuy commented May 1, 2023

These are the minimal changes needed in order to get the docs page to include the actual API for the library.

I added rst table syntax to one section as well so it would properly render the data contained in that comment.

@FoamyGuy
Copy link
Contributor Author
FoamyGuy commented May 1, 2023

resolves: #32

Copy link
Contributor
@jposada202020 jposada202020 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks :). Adding the modules to api.rst is needed by the autodoc extension to generate the documentation. Thank you for changing the table. Looks better

@jposada202020 jposada202020 merged commit 36c01ea into adafruit:main May 1, 2023
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request May 2, 2023
Updating https://github.com/adafruit/Adafruit_CircuitPython_ATECC to 1.2.17 from 1.2.15:
  > Merge pull request adafruit/Adafruit_CircuitPython_ATECC#33 from FoamyGuy/fix_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_ATECC#31 from brass75/issue_25/missing-typehints
  > Add upload url to release action
  > Add .venv to .gitignore
  > Update .pylintrc for v2.15.5
  > Fix release CI files
  > Update pylint to 2.15.5
  > Updated pylint version to 2.13.0
  > Switching to composite actions

Updating https://github.com/adafruit/Adafruit_CircuitPython_LC709203F to 2.3.0 from 2.2.11:
  > Merge pull request adafruit/Adafruit_CircuitPython_LC709203F#25 from jrrickerson/config_voltage_alarm

Updating https://github.com/adafruit/Adafruit_CircuitPython_RockBlock to 1.3.12 from 1.3.11:
  > Merge pull request adafruit/Adafruit_CircuitPython_RockBlock#30 from zachariahpifer/add-type-annotations
  > Add upload url to release action
  > Add .venv to .gitignore

Updating https://github.com/adafruit/Adafruit_CircuitPython_TCS34725 to 3.3.17 from 3.3.16:
  > Merge pull request adafruit/Adafruit_CircuitPython_TCS34725#42 from zemyblue/feat/support_tcs34727
  > Add upload url to release action
  > Add .venv to .gitignore

Updating https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Touchscreen#25 from CedarGroveStudios/patch-1

Updating https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k to 2.5.0 from 2.4.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Wiznet5k#95 from BiffoBear/new_dhcp_state_machine

Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.2.0 from 2.1.8:
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#44 from kalehmann/feature/display_sleep
  > Add upload url to release action
  > Update .pylintrc for v2.15.5
  > Fix release CI files
  > Update pylint to 2.15.5
  > Updated pylint version to 2.13.0
  > Switching to composite actions

Updating https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO to 3.0.10 from 3.0.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#67 from RossK1/adding_type_hints
  > Add upload url to release action
  > Add .venv to .gitignore

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA:
  > Updated download stats for the libraries
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.

2 participants
0