adding example directory and script #67
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Exactly. As the name implies, it's a base class. :) |
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 23, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1106 to 1.2.3 from 1.2.2: > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_SH1106#9 from tekktrik/dev/remove-int > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_SH1106#8 from tekktrik/dev/change-data-to-bytes > Fixed readthedocs build > Post-patch cleanup pt 2 > Post-patch cleanup > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107 to 1.5.2 from 1.5.1: > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_SH1107#13 from tekktrik/dev/change-data-to-bytes > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306 to 1.5.3 from 1.5.2: > Merge pull request adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306#26 from tekktrik/dev/change-data-to-bytes > Fixed readthedocs build > Post-patch cleanup > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch to 1.4.0 from 1.3.0: > Merge pull request adafruit/Adafruit_CircuitPython_FocalTouch#25 from winneymj/main Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1322 to 1.3.1 from 1.3.0: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1322#16 from tekktrik/dev/send-bytes Updating https://github.com/adafruit/Adafruit_CircuitPython_VL53L4CD to 1.0.1 from 1.0.0: > Merge pull request adafruit/Adafruit_CircuitPython_VL53L4CD#2 from caternuson/typo_fix Updating https://github.com/adafruit/Adafruit_CircuitPython_asyncio to 0.5.8 from 0.5.7: > Merge pull request adafruit/Adafruit_CircuitPython_asyncio#21 from FoamyGuy/display_button_example Updating https://github.com/adafruit/Adafruit_CircuitPython_PortalBase to 1.11.3 from 1.11.1: > Merge pull request adafruit/Adafruit_CircuitPython_PortalBase#67 from FoamyGuy/docs_fixes > Merge pull request adafruit/Adafruit_CircuitPython_PortalBase#66 from FoamyGuy/docs_fixes Updating https://github.com/adafruit/Adafruit_CircuitPython_Requests to 1.11.0 from 1.10.7: > Merge pull request adafruit/Adafruit_CircuitPython_Requests#102 from dhalbert/cleanup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Another attempt to resolve the lack of content on the readthedocs page.
I noticed that if you tack on
index.htmlto the URL in RTD it does show a page and the page does have all relevant content on it: https://docs.circuitpython.org/projects/portalbase/en/latest/index.htmlI looked through the raw logs from RTD https://readthedocs.org/projects/adafruit-circuitpython-portalbase/builds/16427060/ Nothing jumps out as immediately problematic to me. I tried to view this side-by-side with another build log from a different library to try to spot differences. The bulk of what I found does seem to make sense to me and I wouldn't think would be causing this issue, but I'm at a bit of a loss for ideas.
One difference I noticed was lack of examples directory. I know the examples do get listed in the docs page so I am working under the theory that maybe if this directory is missing it's causing some problem leading to the empty docs pages.
To test this I've added a PyPortal example into this repo. Ordinarily the user is not intended to use PortalBase directly but rather they would use the things that subclass from it. I think this is likely the reason that there were no examples originally. If this file existing allows the docs to get populated properly, then it may be worth having it here even though it's technically for the subclass rather than this directly.