search

adafruit / Adafruit_CircuitPython_ProgressBar

Dynamic progress bar widget for CircuitPython displays
MIT License
6 stars 9 forks source link

Exposing API components in Readthedocs, adding examples to the Readthedocs API #27

Closed jposada202020 closed 3 years ago

jposada202020 commented 3 years ago

Currently only adafruit_progressbar.ProgressBar is exposed in the Readhedocs API. Adding Examples Adding learning Guides examples

jposada202020 commented 3 years ago

@hugodahl Please review.

I noticed that in the API modules it was included :show-inheritance: I am guessing that the purpose was to show the inheritance diagram. not sure, please ignore this comment if that is not the case.

hugodahl commented 3 years ago

@hugodahl Please review.

I noticed that in the API modules it was included. :show-inheritance: I am guessing that the purpose was to show the inheritance diagram. not sure, please ignore this comment if that is not the case.

Very close. This indicates to sphinx that the generated documentation should include the inherited properties and methods from the base class(es).

The intention is to avoid having to switch between several different pages, tabs or even disconnected sections of a page in ReadTheDocs.

jposada202020 commented 3 years ago

@hugodahl Gotcha. thanks, could you review is the documentation after the PR is showing correctly? :)

jposada202020 commented 3 years ago

Hey @hugodahl, this probably got lost in your inbox, but if you could review the requested changes when you get a chance, that would be great 😄 😄

jposada202020 commented 3 years ago

Thanks Hugo, for reviewing :) and everything