docs: set up Sphinx/Read the Docs scaffold - #28
Open
IFX-Anusha wants to merge 1 commit into
Open
IFX-Anusha wants to merge 1 commit into
IFX-Anusha wants to merge 1 commit into
Conversation
IFX-Anusha
requested review from
AkshayChandra-IFX,
djaumann,
ederjc and
jaenrig-ifx
October 5, 2026 08:33
|
Looks good so far :) |
djaumann
approved these changes
Oct 5, 2026
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
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 ---
CONTRIBUTING.md also tells you what to expect in the PR process.
Description
Summary
Sets up a Sphinx / Read the Docs scaffold for this repo, matching the structure used by
arduino-core-psoc6.What's included
.readthedocs.yaml— RTD build config (Sphinx,docs/conf.py,docs/requirements.txt)docs/conf.py— Sphinx config (sphinx_rtd_theme, project "Arduino Core for Zephyr")docs/requirements.txt,docs/Makefile,docs/make.bat— build toolingdocs/index.rst— top-level toctree (CONTENT / CONTRIBUTING sections)installation-instructions.rst,hw-platforms.rst,arduino-deviations.rst,contributing.rst,env-setup.rst,run-tests.rstNot included yet
.. TODOplaceholders)Verification
sphinx-build -b html docs docs/_buildsucceeds cleanly (no warnings/errors)