-
-
Notifications
You must be signed in to change notification settings - Fork 79
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
Adding WiFiS3 API documentation #415
Open
BenjaminDannegard
wants to merge
23
commits into
arduino:main
Choose a base branch
from
BenjaminDannegard:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
ecab85d
API documentation
BenjaminDannegard 12a02c9
Api docs
BenjaminDannegard 45de986
Added API tags
BenjaminDannegard c116b89
GPT fix
BenjaminDannegard 38503fe
Update
BenjaminDannegard 38d6751
Update
BenjaminDannegard 96df3e6
Updated API docs
BenjaminDannegard 17f2913
Merge branch 'arduino:main' into benjamindannegard/api-documentation
BenjaminDannegard 003c19d
Updated API
BenjaminDannegard c74ed4d
Add API docs workflow
sebromero c8716e0
api docs update
BenjaminDannegard ff3171e
Added more documentation
BenjaminDannegard ae58089
More api documentation
BenjaminDannegard fb14228
Fixed wifi.h api docs
BenjaminDannegard 6a4093e
Finished API docs
BenjaminDannegard c0a276e
Merge pull request #1 from BenjaminDannegard/docs
BenjaminDannegard 70bf179
First api.h draft
BenjaminDannegard 6b8ebbb
Fixed for formating
BenjaminDannegard be2e2fb
Fixed api docs file
BenjaminDannegard 5fb1ea3
Merge pull request #2 from BenjaminDannegard/benjamindannegard/api-do…
BenjaminDannegard 20a2010
Update documentation
actions-user 1399224
Removed unused tags
BenjaminDannegard a382728
Fixed formatting
BenjaminDannegard File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Render Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- ".github/workflows/render-documentation.ya?ml" | ||
- "./libraries/WiFiS3/examples/**" | ||
- "./libraries/WiFiS3/src/**" | ||
pull_request: | ||
branches: | ||
- main | ||
paths: | ||
- ".github/workflows/render-documentation.ya?ml" | ||
- "./libraries/WiFiS3/examples/**" | ||
- "./libraries/WiFiS3/src/**" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
render-docs: | ||
permissions: | ||
contents: write | ||
uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@main | ||
with: | ||
source-path: './libraries/WiFiS3/src' | ||
target-path: './libraries/WiFiS3/docs/api.md' | ||
exclude-pattern: 'StringHelpers.h WiFi.h Modem.h' | ||
commit: ${{ github.event_name != 'pull_request' }} # Only commit changes if not a PR |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,4 @@ cores/arduino/mydebug.cpp.donotuse | |
.DS_Store? | ||
/.vs | ||
/.gitignore | ||
.vscode/settings.json |
Oops, something went wrong.
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.
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.
Typo?
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.
@sebromero?
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.
The question mark? No, that's there to allow both .yaml and .yml