Open
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR sets up automated Sphinx documentation generation by adding CI workflows and the necessary configuration and build scripts.
- Introduce a GitHub Actions workflow to build docs on relevant events
- Add Sphinx configuration (
conf.py) and support files (Makefile,make.bat) - Update documentation dependencies and include a status badge in
README.md
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/build_docs.yml | Added workflow for automatic docs builds |
| docs/requirements.txt | Simplified and unpinned Sphinx-related dependencies |
| docs/conf.py | Updated Sphinx project metadata and extensions |
| docs/Makefile | Added minimal makefile for docs build |
| docs/make.bat | Added Windows batch script for docs build |
| README.md | Added documentation build status badge |
Comments suppressed due to low confidence (3)
README.md:3
- The badge references the 'adddocscheck' branch; after merge this will break. Consider pointing the badge to the default branch (e.g., 'main').
[](https://github.com/Infineon/high-side-switch/actions/workflows/build_docs.yml)
docs/conf.py:25
- [nitpick] The copyright year is set to 2022; consider updating it to the current year or using a dynamic value to reflect ongoing maintenance.
copyright = '2022 Infineon Technologies AG'
docs/conf.py:77
- HTML generation has been disabled by setting
GENERATE_HTML = NO; this may prevent HTML docs from being built. If unintentional, revert toYES.
GENERATE_HTML = NO
docs/requirements.txt
Outdated
Comment on lines
1
to
8
| Sphinx | ||
| sphinx-rtd-theme | ||
| sphinx-sitemap | ||
| recommonmark | ||
| sphinxemoji | ||
| sphinx-tabs | ||
| breathe>=4.13.0 | ||
| breathe | ||
| exhale |
There was a problem hiding this comment.
[nitpick] Unpinned documentation dependencies may lead to builds that vary over time; consider specifying version constraints to ensure reproducible builds.
wxyyy0117
force-pushed
the
adddocscheck
branch
3 times, most recently
from
470a51e to
d7dd762
Compare
…switch into adddocscheck
…switch into adddocscheck
…switch into adddocscheck
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ederjc
requested changes
Jul 16, 2025
docs/conf.py
Outdated
|
|
||
| breathe_projects = { | ||
| "High-Side Switch": "build/xml/" | ||
| "Arduino MOTIX™ BTN99x0": "build/xml/" |
docs/conf.py
Outdated
| } | ||
| breathe_default_project = "High-Side Switch" | ||
| breathe_default_members = ('members', 'undoc-members') No newline at end of file | ||
| breathe_default_project = "Arduino MOTIX™ BTN99x0" |
ederjc
requested changes
Jul 18, 2025
docs/requirements.txt
Outdated
| sphinx-sitemap>=2.2.0 | ||
| recommonmark>=0.6.0 | ||
| sphinxemoji>=0.1.8 | ||
| Sphinx |
docs/conf.py
Outdated
|
|
||
| breathe_projects = { | ||
| "High-Side Switch": "build/xml/" | ||
| "HIGH-SIDE-SWITCH": "build/xml/" |
docs/conf.py
Outdated
| } | ||
| breathe_default_project = "High-Side Switch" | ||
| breathe_default_members = ('members', 'undoc-members') No newline at end of file | ||
| breathe_default_project = "HIGH-SIDE-SWITCH" |
…switch into adddocscheck
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---
This pull request introduces documentation generation for the project using Sphinx and updates the documentation configuration files. The changes include adding a GitHub Actions workflow for building documentation, updating project information in
conf.py, and creating new files required for Sphinx-based documentation builds.Documentation Build Setup:
.github/workflows/build_docs.yml: Added a GitHub Actions workflow to automatically build documentation onpushandpull_requestevents affecting thedocsdirectory.README.md: Included a badge linking to the documentation build status.Sphinx Configuration Updates:
docs/conf.py: Updated project metadata , added the release version (1.1.0), and refined Sphinx extensions and configurations (e.g., removed deprecated settings, switched to usingsphinx_rtd_theme). [1] [2] [3] [4] [5]Build Support Files:
docs/Makefile: Added a minimal makefile for building Sphinx documentation.docs/make.bat: Added a batch file for building Sphinx documentation on Windows systems.Dependency Management:
docs/requirements.txt: Simplified the dependency list by removing version constraints for Sphinx-related packages.