-
Notifications
You must be signed in to change notification settings - Fork 2
Updates to Docs #4
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
Conversation
Extract the guide out into a new file - overview.rst
|
@lesamouraipourpre Indeed as you have witnessed my efforts to reduce memory footprint, this makes sense for boards with low memory avalaible, as the heap size limits the amount of code lines they can load. |
|
and a +1 for @kmatch98 documentation, it was the source for our standard on |
|
Seems like a great idea. I didn’t build or review but feel free to reorganize. I especially appreciate taking the docs out of the code file since it will shrink the file a bit. |
kattni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is fine. As long as the docs end up generated, it doesn't matter from where they're generating. Thanks for the work on this!
|
Good catch @jposada202020. I think I had gone document blind by that point - If it drew a diagram it must be correct. |
|
THANKS!! @lesamouraipourpre |
conf.pytoadafruit_displayio_layout, specifically for theWidgetandControlclass.displayio_switchround.pytodocs/overview.rst. This dramatically reduces the size ofdisplayio_switchround.pyfor anyone installing the.pyfiledisplayio_switchround.pyto near the top.overview.rstguide at the place discussing inheritance.@kmatch98 I've tried to make only minimal changes to the wonderful work you've done on this, focusing mainly on adding cross-reference links. Can you have a read of this to confirm that it still makes sense, please?
@jposada202020 Does this separation of the
overview.rstmake sense with what you are trying to achieve in library documentation?