docs(site): unified microrobotica.org with sphinx-multiproject + PyData theme - #2
Merged
Merged
Conversation
…ta theme
The new docs site lives in MICROROBOTICA/docs/ and bundles three
projects (MADDENING, MIME, MICROROBOTICA) into a single deployable
GitHub Pages target backed by the microrobotica.org domain.
Layout
------
* `docs/conf.py` — shared configuration; sphinx-multiproject switches
the active project via `$PROJECT` (microrobotica | maddening | mime).
* `docs/projects/{maddening,mime}` — git submodules tracking each
project's `main`. Their `docs/` subdirs are the subproject sources.
* `docs/index.rst` — landing page. Hero block autoplays the two
showcase videos (dipole-arm closed-loop control, MIME's de Jongh
replication) immediately on page load, then a 3-card grid links to
the three projects.
* `docs/_static/custom.css` — hero + card styling layered on PyData.
* `docs/assets/videos/*.mp4` — copied to `<output>/videos/` via
`html_extra_path` so the hero `<video>` tags resolve.
* `docs/Makefile` — `make all` runs maddening, mime, microrobotica in
sequence into `_build/html/{,maddening/,mime/}` and writes
`.nojekyll` + the CNAME.
* `docs/CNAME` — `microrobotica.org`.
* `docs/requirements.txt` — sphinx, multiproject, pydata-sphinx-theme,
myst-parser, sphinx-design, breathe, linkify.
CI
--
* `.github/workflows/docs.yml` builds on every PR and deploys
`docs/_build/html/` to GitHub Pages on push to `main`. Submodules
are checked out recursively; doxygen/graphviz installed before the
breathe build.
Doxygen / breathe
-----------------
* The microrobotica project loads breathe and points it at
`_doxygen/xml`. The Makefile re-runs Doxygen before the sphinx
build so the C++ XML is fresh.
Misc
----
* Light prose polish on `docs/user_guide/index.md` and
`docs/developer_guide/index.md` — replaced the "Content pending"
stub and rewrote the broken `../../CONTRIBUTING.md` link as an
absolute github.com URL.
* `.gitignore`: stop ignoring `_static/` and `_templates/` — they
now hold versioned theme assets, not generated output.
Co-Authored-By: Claude Opus 4.7 (1M context) <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
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.
Summary
Unified docs site for the three projects (MADDENING, MIME, MICROROBOTICA) deployed to GitHub Pages → `microrobotica.org`.
Domain / TLS rollout (manual, post-merge)
Test plan
Known follow-ups
🤖 Generated with Claude Code