Skip to content

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

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
Merged
merged 2 commits into from
May 13, 2021
Merged

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

merged 2 commits into from
May 13, 2021

Conversation

jposada202020
Copy link
Contributor

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

@jposada202020 jposada202020 added the documentation Improvements or additions to documentation label May 1, 2021
@jposada202020
Copy link
Contributor Author

jposada202020 commented May 1, 2021 •
edited
Loading

@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
Copy link
Contributor

hugodahl commented May 1, 2021

@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
Copy link
Contributor Author

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

@jposada202020
Copy link
Contributor Author

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 😄 😄

hugodahl
hugodahl approved these changes May 13, 2021
View reviewed changes
Copy link
Contributor

@hugodahl hugodahl left a comment

Choose a reason for hiding this comment

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

Looks good to me. Nice having the examples inline in the docs!

@jposada202020
Copy link
Contributor Author

Thanks Hugo, for reviewing :) and everything

@jposada202020 jposada202020 merged commit 8c8c8cd into adafruit:master May 13, 2021
@jposada202020 jposada202020 deleted the improving_docs branch May 13, 2021 21:47
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request May 18, 2021
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@41b2432)
c311377 
Updating https://github.com/adafruit/Adafruit_CircuitPython_CharLCD to 3.3.10 from 3.3.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#62 from jposada202020/correcting_rtype_documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#61 from lesamouraipourpre/docs-and-examples
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTU21D to 0.11.0 from 0.10.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU21D#16 from jposada202020/adding_temp_rh_resolution

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTU31D to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU31D#5 from jposada202020/adding_temp_rh_resolution_properties
  > Merge pull request adafruit/Adafruit_CircuitPython_HTU31D#4 from jposada202020/correcting_conversion_formulas
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_MONSTERM4SK to 0.1.3 from 0.1.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_MONSTERM4SK#3 from FoamyGuy/add_jackolantern_example
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_Seesaw to 1.8.2 from 1.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_seesaw#66 from jposada202020/examples_api

Updating https://github.com/adafruit/Adafruit_CircuitPython_SHT4x to 1.0.6 from 1.0.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_SHT4x#7 from jposada202020/correcting_print

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.11.4 from 2.11.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#60 from mrouillard/fix-decimal-separator-issue

Updating https://github.com/adafruit/Adafruit_CircuitPython_FakeRequests to 1.0.3 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_FakeRequests#4 from jposada202020/main
  > "Increase duplicate code check threshold "
  > Merge pull request adafruit/Adafruit_CircuitPython_FakeRequests#3 from FoamyGuy/pylintrc_and_versions

Updating https://github.com/adafruit/Adafruit_CircuitPython_FunHouse to 2.1.1 from 2.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_FunHouse#14 from makermelissa/main
  > Merge pull request adafruit/Adafruit_CircuitPython_FunHouse#13 from joezilla86/Docstring-updates

Updating https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar to 2.1.1 from 2.1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ProgressBar#27 from jposada202020/improving_docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugodahl hugodahl hugodahl approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jposada202020 @hugodahl