Closed kolipakakondal closed 1 week ago
[!WARNING]
Review failed
The pull request is closed.
The updates predominantly introduce a comprehensive GitHub Actions workflow designed for documentation building and deployment, both for preview and production environments, targeting various branches. Additionally, several new documentation files and configurations tailored for Espressif-IDE have been added, covering installation, configuration, and feature specifics aimed at simplifying the development process for IoT applications using the ESP-IDF framework.
File/Path | Change Summary |
---|---|
.github/workflows/docs_build.yml |
Introduced workflow for building and deploying documentation on certain branch pushes and path changes. |
.github/workflows/docs_production.yml |
Introduced workflow for building and deploying documentation to production upon certain triggers. |
.gitignore |
Added ignore rules for .DS_Store files and directories under /docs and /.github/ . |
docs/README.md , docs/en/**/*.rst |
Added new files providing detailed documentation for Espressif-IDE, including installation, configuration, and features. |
docs/conf_common.py |
Added new configurations for documentation generation, including extensions, context settings, and static paths. |
docs/requirements.txt |
Updated dependencies to include specific versions of esp-docs , sphinx-copybutton , and sphinx-tabs . |
docs/utils.sh |
Introduced Bash helper functions for adding SSH keys and configuring SSH settings for specific servers. |
In cyberspace where actions play,
Espressif docs find their way.
Build and deploy with ease anew,
GitHub workflows guiding through.
Configs, installs, features bright,
All in docs, now clear in sight. 🐰📚
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
We have structure in-place and able to publish it https://preview-docs.espressif.com/projects/espressif-ide/en/997-merge/index.html
Description
Please include a summary of the change and which issue is fixed.
Fixes # (IEP-XXX)
Type of change
Please delete options that are not relevant.
How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit
New Features
Chores
.gitignore
to ignore various.DS_Store
files and directories for cleaner repository management.docs/requirements.txt
.Documentation