Skip to content
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

LcdMenu 5.0.0 Documentation #230

Merged
merged 74 commits into from
Oct 4, 2024
Merged

Conversation

forntoh
Copy link
Owner

@forntoh forntoh commented Oct 1, 2024

Temporary deployment:
Screenshot 2024-10-03 at 14 26 13

  • Overall docs
  • Migration Guide for v5.x.x

Added permissions for contents, pages, and id-token in the workflow file to control access levels.
Changed contents permission from read to write.
… command menu item with examples. New image added for toggle menu item. More details provided on creating different types of command menu items.
- Adjusted grid layout in the index file
- Added a new license file with updated copyright year
…etup, and modify copyright format.

- Add an extra header link icon for author info in the HTML theme options. Refactor toggle command menu item logic for LED control.
- Remove "toggle" from the list of menu item types in the deep dive overview.
- Added a new HTML template for displaying badges on the page.
- Included links to various badge images related to the project.
- Updated copyright format in conf.py to remove unnecessary comma.
- Added 'custom.css' as a CSS file for styling in the documentation.
- Changed pip install path for requirements
- Added pre-build step to execute pre_build.bat
- Updated README instructions for generating docs
Added a command to install Doxygen using apt-get in the README file. This will help users easily set up the necessary tool for generating documentation.
- Added commands to install necessary dependencies before building documentation.
- Replaced 'sudo apt-get' with 'apt-get'
- Removed unnecessary sudo commands
- Updated pre-build script to improve execution
The commit updates the readthedocs.yml file to use 'sudo' before 'apt-get update' and 'apt-get install' commands. This change ensures proper permissions are used when running these commands.
Changed the job name from post_install to pre_system_dependencies in the configuration file to reflect the correct stage for installing necessary packages before building.
The commit adds doxygen, graphviz, default-jre, and plantuml as apt packages for the build process. The previous method of installing these packages using 'apt-get install' has been replaced with direct specification in the configuration file.
Repository owner deleted a comment from github-actions bot Oct 1, 2024
Repository owner deleted a comment from github-actions bot Oct 1, 2024
Repository owner deleted a comment from github-actions bot Oct 1, 2024
Repository owner deleted a comment from github-actions bot Oct 1, 2024
Repository owner deleted a comment from github-actions bot Oct 1, 2024
Copy link
Contributor

github-actions bot commented Oct 1, 2024

Memory usage change @ 9e8fb76

Board flash % RAM for global variables %
arduino:avr:uno 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/Basic
flash
% examples/Basic
RAM for global variables
% examples/ButtonAdapter
flash
% examples/ButtonAdapter
RAM for global variables
% examples/ButtonWithRotaryAdapter
flash
% examples/ButtonWithRotaryAdapter
RAM for global variables
% examples/Callbacks
flash
% examples/Callbacks
RAM for global variables
% examples/CharsetInput
flash
% examples/CharsetInput
RAM for global variables
% examples/InputRotary
flash
% examples/InputRotary
RAM for global variables
% examples/IntFloatValues
flash
% examples/IntFloatValues
RAM for global variables
% examples/ItemBack
flash
% examples/ItemBack
RAM for global variables
% examples/KeyboardAdapter
flash
% examples/KeyboardAdapter
RAM for global variables
% examples/List
flash
% examples/List
RAM for global variables
% examples/MenuTimeout
flash
% examples/MenuTimeout
RAM for global variables
% examples/RTOS
flash
% examples/RTOS
RAM for global variables
% examples/SimpleInput
flash
% examples/SimpleInput
RAM for global variables
% examples/SimpleRotary
flash
% examples/SimpleRotary
RAM for global variables
% examples/SubMenu
flash
% examples/SubMenu
RAM for global variables
%
arduino:avr:uno 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/Basic<br>flash,%,examples/Basic<br>RAM for global variables,%,examples/ButtonAdapter<br>flash,%,examples/ButtonAdapter<br>RAM for global variables,%,examples/ButtonWithRotaryAdapter<br>flash,%,examples/ButtonWithRotaryAdapter<br>RAM for global variables,%,examples/Callbacks<br>flash,%,examples/Callbacks<br>RAM for global variables,%,examples/CharsetInput<br>flash,%,examples/CharsetInput<br>RAM for global variables,%,examples/InputRotary<br>flash,%,examples/InputRotary<br>RAM for global variables,%,examples/IntFloatValues<br>flash,%,examples/IntFloatValues<br>RAM for global variables,%,examples/ItemBack<br>flash,%,examples/ItemBack<br>RAM for global variables,%,examples/KeyboardAdapter<br>flash,%,examples/KeyboardAdapter<br>RAM for global variables,%,examples/List<br>flash,%,examples/List<br>RAM for global variables,%,examples/MenuTimeout<br>flash,%,examples/MenuTimeout<br>RAM for global variables,%,examples/RTOS<br>flash,%,examples/RTOS<br>RAM for global variables,%,examples/SimpleInput<br>flash,%,examples/SimpleInput<br>RAM for global variables,%,examples/SimpleRotary<br>flash,%,examples/SimpleRotary<br>RAM for global variables,%,examples/SubMenu<br>flash,%,examples/SubMenu<br>RAM for global variables,%
arduino:avr:uno,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

Copy link
Contributor

github-actions bot commented Oct 3, 2024

Memory usage change @ 9695756

Board flash % RAM for global variables %
arduino:avr:uno 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/Basic
flash
% examples/Basic
RAM for global variables
% examples/ButtonAdapter
flash
% examples/ButtonAdapter
RAM for global variables
% examples/ButtonWithRotaryAdapter
flash
% examples/ButtonWithRotaryAdapter
RAM for global variables
% examples/Callbacks
flash
% examples/Callbacks
RAM for global variables
% examples/CharsetInput
flash
% examples/CharsetInput
RAM for global variables
% examples/InputRotary
flash
% examples/InputRotary
RAM for global variables
% examples/IntFloatValues
flash
% examples/IntFloatValues
RAM for global variables
% examples/ItemBack
flash
% examples/ItemBack
RAM for global variables
% examples/KeyboardAdapter
flash
% examples/KeyboardAdapter
RAM for global variables
% examples/List
flash
% examples/List
RAM for global variables
% examples/MenuTimeout
flash
% examples/MenuTimeout
RAM for global variables
% examples/RTOS
flash
% examples/RTOS
RAM for global variables
% examples/SimpleInput
flash
% examples/SimpleInput
RAM for global variables
% examples/SimpleRotary
flash
% examples/SimpleRotary
RAM for global variables
% examples/SubMenu
flash
% examples/SubMenu
RAM for global variables
%
arduino:avr:uno 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/Basic<br>flash,%,examples/Basic<br>RAM for global variables,%,examples/ButtonAdapter<br>flash,%,examples/ButtonAdapter<br>RAM for global variables,%,examples/ButtonWithRotaryAdapter<br>flash,%,examples/ButtonWithRotaryAdapter<br>RAM for global variables,%,examples/Callbacks<br>flash,%,examples/Callbacks<br>RAM for global variables,%,examples/CharsetInput<br>flash,%,examples/CharsetInput<br>RAM for global variables,%,examples/InputRotary<br>flash,%,examples/InputRotary<br>RAM for global variables,%,examples/IntFloatValues<br>flash,%,examples/IntFloatValues<br>RAM for global variables,%,examples/ItemBack<br>flash,%,examples/ItemBack<br>RAM for global variables,%,examples/KeyboardAdapter<br>flash,%,examples/KeyboardAdapter<br>RAM for global variables,%,examples/List<br>flash,%,examples/List<br>RAM for global variables,%,examples/MenuTimeout<br>flash,%,examples/MenuTimeout<br>RAM for global variables,%,examples/RTOS<br>flash,%,examples/RTOS<br>RAM for global variables,%,examples/SimpleInput<br>flash,%,examples/SimpleInput<br>RAM for global variables,%,examples/SimpleRotary<br>flash,%,examples/SimpleRotary<br>RAM for global variables,%,examples/SubMenu<br>flash,%,examples/SubMenu<br>RAM for global variables,%
arduino:avr:uno,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

Added a centered image tag to display the menu system example in README.md.
Restrict push to master branch in the workflow configuration.
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Memory usage change @ f7a43ed

Board flash % RAM for global variables %
arduino:avr:uno 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/Basic
flash
% examples/Basic
RAM for global variables
% examples/ButtonAdapter
flash
% examples/ButtonAdapter
RAM for global variables
% examples/ButtonWithRotaryAdapter
flash
% examples/ButtonWithRotaryAdapter
RAM for global variables
% examples/Callbacks
flash
% examples/Callbacks
RAM for global variables
% examples/CharsetInput
flash
% examples/CharsetInput
RAM for global variables
% examples/InputRotary
flash
% examples/InputRotary
RAM for global variables
% examples/IntFloatValues
flash
% examples/IntFloatValues
RAM for global variables
% examples/ItemBack
flash
% examples/ItemBack
RAM for global variables
% examples/KeyboardAdapter
flash
% examples/KeyboardAdapter
RAM for global variables
% examples/List
flash
% examples/List
RAM for global variables
% examples/MenuTimeout
flash
% examples/MenuTimeout
RAM for global variables
% examples/RTOS
flash
% examples/RTOS
RAM for global variables
% examples/SimpleInput
flash
% examples/SimpleInput
RAM for global variables
% examples/SimpleRotary
flash
% examples/SimpleRotary
RAM for global variables
% examples/SubMenu
flash
% examples/SubMenu
RAM for global variables
%
arduino:avr:uno 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/Basic<br>flash,%,examples/Basic<br>RAM for global variables,%,examples/ButtonAdapter<br>flash,%,examples/ButtonAdapter<br>RAM for global variables,%,examples/ButtonWithRotaryAdapter<br>flash,%,examples/ButtonWithRotaryAdapter<br>RAM for global variables,%,examples/Callbacks<br>flash,%,examples/Callbacks<br>RAM for global variables,%,examples/CharsetInput<br>flash,%,examples/CharsetInput<br>RAM for global variables,%,examples/InputRotary<br>flash,%,examples/InputRotary<br>RAM for global variables,%,examples/IntFloatValues<br>flash,%,examples/IntFloatValues<br>RAM for global variables,%,examples/ItemBack<br>flash,%,examples/ItemBack<br>RAM for global variables,%,examples/KeyboardAdapter<br>flash,%,examples/KeyboardAdapter<br>RAM for global variables,%,examples/List<br>flash,%,examples/List<br>RAM for global variables,%,examples/MenuTimeout<br>flash,%,examples/MenuTimeout<br>RAM for global variables,%,examples/RTOS<br>flash,%,examples/RTOS<br>RAM for global variables,%,examples/SimpleInput<br>flash,%,examples/SimpleInput<br>RAM for global variables,%,examples/SimpleRotary<br>flash,%,examples/SimpleRotary<br>RAM for global variables,%,examples/SubMenu<br>flash,%,examples/SubMenu<br>RAM for global variables,%
arduino:avr:uno,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

@forntoh forntoh enabled auto-merge (squash) October 4, 2024 13:07
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Memory usage change @ dbed352

Board flash % RAM for global variables %
arduino:avr:uno 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/Basic
flash
% examples/Basic
RAM for global variables
% examples/ButtonAdapter
flash
% examples/ButtonAdapter
RAM for global variables
% examples/ButtonWithRotaryAdapter
flash
% examples/ButtonWithRotaryAdapter
RAM for global variables
% examples/Callbacks
flash
% examples/Callbacks
RAM for global variables
% examples/CharsetInput
flash
% examples/CharsetInput
RAM for global variables
% examples/InputRotary
flash
% examples/InputRotary
RAM for global variables
% examples/IntFloatValues
flash
% examples/IntFloatValues
RAM for global variables
% examples/ItemBack
flash
% examples/ItemBack
RAM for global variables
% examples/KeyboardAdapter
flash
% examples/KeyboardAdapter
RAM for global variables
% examples/List
flash
% examples/List
RAM for global variables
% examples/MenuTimeout
flash
% examples/MenuTimeout
RAM for global variables
% examples/RTOS
flash
% examples/RTOS
RAM for global variables
% examples/SimpleInput
flash
% examples/SimpleInput
RAM for global variables
% examples/SimpleRotary
flash
% examples/SimpleRotary
RAM for global variables
% examples/SubMenu
flash
% examples/SubMenu
RAM for global variables
%
arduino:avr:uno 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/Basic<br>flash,%,examples/Basic<br>RAM for global variables,%,examples/ButtonAdapter<br>flash,%,examples/ButtonAdapter<br>RAM for global variables,%,examples/ButtonWithRotaryAdapter<br>flash,%,examples/ButtonWithRotaryAdapter<br>RAM for global variables,%,examples/Callbacks<br>flash,%,examples/Callbacks<br>RAM for global variables,%,examples/CharsetInput<br>flash,%,examples/CharsetInput<br>RAM for global variables,%,examples/InputRotary<br>flash,%,examples/InputRotary<br>RAM for global variables,%,examples/IntFloatValues<br>flash,%,examples/IntFloatValues<br>RAM for global variables,%,examples/ItemBack<br>flash,%,examples/ItemBack<br>RAM for global variables,%,examples/KeyboardAdapter<br>flash,%,examples/KeyboardAdapter<br>RAM for global variables,%,examples/List<br>flash,%,examples/List<br>RAM for global variables,%,examples/MenuTimeout<br>flash,%,examples/MenuTimeout<br>RAM for global variables,%,examples/RTOS<br>flash,%,examples/RTOS<br>RAM for global variables,%,examples/SimpleInput<br>flash,%,examples/SimpleInput<br>RAM for global variables,%,examples/SimpleRotary<br>flash,%,examples/SimpleRotary<br>RAM for global variables,%,examples/SubMenu<br>flash,%,examples/SubMenu<br>RAM for global variables,%
arduino:avr:uno,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

Copy link
Contributor

github-actions bot commented Oct 4, 2024

Memory usage change @ f2c3a69

Board flash % RAM for global variables %
arduino:avr:uno 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/Basic
flash
% examples/Basic
RAM for global variables
% examples/ButtonAdapter
flash
% examples/ButtonAdapter
RAM for global variables
% examples/ButtonWithRotaryAdapter
flash
% examples/ButtonWithRotaryAdapter
RAM for global variables
% examples/Callbacks
flash
% examples/Callbacks
RAM for global variables
% examples/CharsetInput
flash
% examples/CharsetInput
RAM for global variables
% examples/InputRotary
flash
% examples/InputRotary
RAM for global variables
% examples/IntFloatValues
flash
% examples/IntFloatValues
RAM for global variables
% examples/ItemBack
flash
% examples/ItemBack
RAM for global variables
% examples/KeyboardAdapter
flash
% examples/KeyboardAdapter
RAM for global variables
% examples/List
flash
% examples/List
RAM for global variables
% examples/MenuTimeout
flash
% examples/MenuTimeout
RAM for global variables
% examples/RTOS
flash
% examples/RTOS
RAM for global variables
% examples/SimpleInput
flash
% examples/SimpleInput
RAM for global variables
% examples/SimpleRotary
flash
% examples/SimpleRotary
RAM for global variables
% examples/SubMenu
flash
% examples/SubMenu
RAM for global variables
%
arduino:avr:uno 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/Basic<br>flash,%,examples/Basic<br>RAM for global variables,%,examples/ButtonAdapter<br>flash,%,examples/ButtonAdapter<br>RAM for global variables,%,examples/ButtonWithRotaryAdapter<br>flash,%,examples/ButtonWithRotaryAdapter<br>RAM for global variables,%,examples/Callbacks<br>flash,%,examples/Callbacks<br>RAM for global variables,%,examples/CharsetInput<br>flash,%,examples/CharsetInput<br>RAM for global variables,%,examples/InputRotary<br>flash,%,examples/InputRotary<br>RAM for global variables,%,examples/IntFloatValues<br>flash,%,examples/IntFloatValues<br>RAM for global variables,%,examples/ItemBack<br>flash,%,examples/ItemBack<br>RAM for global variables,%,examples/KeyboardAdapter<br>flash,%,examples/KeyboardAdapter<br>RAM for global variables,%,examples/List<br>flash,%,examples/List<br>RAM for global variables,%,examples/MenuTimeout<br>flash,%,examples/MenuTimeout<br>RAM for global variables,%,examples/RTOS<br>flash,%,examples/RTOS<br>RAM for global variables,%,examples/SimpleInput<br>flash,%,examples/SimpleInput<br>RAM for global variables,%,examples/SimpleRotary<br>flash,%,examples/SimpleRotary<br>RAM for global variables,%,examples/SubMenu<br>flash,%,examples/SubMenu<br>RAM for global variables,%
arduino:avr:uno,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

@forntoh forntoh merged commit b146b04 into feature/move-control-to-items Oct 4, 2024
16 checks passed
@forntoh forntoh deleted the feature/new-docs branch October 4, 2024 15:19
@github-actions github-actions bot mentioned this pull request Oct 7, 2024
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants