include CONFIGURE.md in generated documentation #164
Conversation
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
Codecov ReportAttention: Patch coverage is
❌ Your patch check has failed because the patch coverage (25.00%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #164 +/- ##
==========================================
- Coverage 90.76% 90.34% -0.42%
==========================================
Files 35 35
Lines 2500 2516 +16
==========================================
+ Hits 2269 2273 +4
- Misses 231 243 +12 ☔ View full report in Codecov by Sentry. |
squioc
force-pushed
the
feat/AutomationDocGeneration
branch
from
624e570 to
c7322bc
Compare
Darkheir
approved these changes
Feb 14, 2025
| with (module_path / "CONFIGURE.md").open("r") as fd: | ||
| content = fd.read() | ||
|
|
||
| # Copy the assets for the documentation and update the path |
There was a problem hiding this comment.
Maybe the assets copy should be independant from the configure.md in case we want to also include images in the description.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Include CONFIGURE.md and docs/assets/ into the generated documentation of automation modules.
The purpose is to improve the documentation of automation modules with a section explaining how to generate the credentials for the module.
This information will be put in the CONFIGURE.md in the automation module. Assets like images will be put in
docs/assetsin the automation module.