docs: add Sphinx documentation site#41
Merged
Merged
Conversation
Scaffold a Sphinx + MyST docs site matching the PyMCU docs styling (pydata-sphinx-theme, sphinx-design, copybutton), ready to publish on the shared docs.pymcu.org site. - Sections: getting-started, guides (testkit, ci-validation, gdb-debugging), peripherals, compat, reference. - conf.py sets html_baseurl for the /rp2040sharp sub-path and links back to docs.pymcu.org. - docs.yml builds with sphinx-build -W and deploys to Cloudflare Pages (project rp2040sharp-docs), mirroring the PyMCU pipeline. Builds clean with `sphinx-build -W`. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…he docs The docs site is built and deployed by Cloudflare Pages' Git integration (build: sphinx-build, output: docs/_build/html), not by Actions. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Description
Scaffolds a Sphinx + MyST documentation site for RP2040Sharp, matching the PyMCU docs
styling so it can be published on the shared
docs.pymcu.orgsite.pydata-sphinx-theme+ MyST (Markdown) +sphinx-design+ copybutton —same as the PyMCU docs.
debugging), Peripherals (coverage table), Compatibility (MicroPython/CircuitPython/bare-metal),
Reference (key types).
conf.py: setshtml_baseurlfor the/rp2040sharpsub-path and adds an icon linkback to
docs.pymcu.org.docs.yml: builds withsphinx-build -W(warnings = errors) on changes todocs/**and deploys to Cloudflare Pages (project
rp2040sharp-docs), mirroring the PyMCU pipeline.Builds clean locally with
sphinx-build -W.Type of change
Checklist
dotnet test)