docs: migrate from Jupyter Book to Docusaurus#57
Merged
Conversation
Port the existing documentation from Jupyter Book to a Docusaurus site under docs/, mirroring the layout and theming used by Delphi. Replace the gh-pages-based deploy job with the GitHub Pages artifact pipeline, and add a release workflow that handles version bumps, changelog updates, and Docusaurus version snapshots on labeled PRs into main. CHANGELOG is reformatted to Keep-a-Changelog so the release workflow's sed/awk drives the [Unreleased] header rewrite and comparison links.
Update Docusaurus config (url, organizationName, edit/footer links), release workflow REPO variable, and CHANGELOG comparison links to use the canonical MDO-Standards org instead of chrislupp. Also expand the Unreleased CHANGELOG entry with the docs migration, deploy workflow swap, and release workflow additions.
The Sellar example set input defaults on the inner `cycle` subgroup, but `obj_cmp` promoted `x` and `z` to the top level with different defaults; newer OpenMDAO releases reject this during `final_setup`. Move the defaults to the top-level `SellarMDA` group so the promoted values agree. Also update `test_implicit_discipline_apply_linear_not_implemented` to pass the current six-argument signature; the stale three-argument call was raising `TypeError` before the `NotImplementedError` assertion could fire.
chrislupp
added
bug
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
docs/, mirroring the layout, theming, and configuration used by Delphi (dark-mode default, KaTeX math, custom hero with an animated client/server SVG and Python paraboloid snippet).peaceiris/actions-gh-pagesjupyter-book deploy job with the GitHub Pages artifact pipeline (actions/configure-pages+upload-pages-artifact+deploy-pages), triggered ondevelopfordocs/**..github/workflows/release.yamlmirroring Delphi's release workflow: PR-label-driven version bumps, signed commits,pyproject.tomlversion update,CHANGELOG.mdrewrite,docusaurus docs:versionsnapshot for stable releases, GitHub Release creation, and auto-mergemainback todevelop.CHANGELOG.mdto Keep-a-Changelog so the release workflow'ssed/awkdrives the[Unreleased]rewrite and comparison links.Test plan
cd docs && npm ci && npm run buildsucceeds locally (verified during development).Deploy Docsworkflow runs ondevelopand publishes to GitHub Pages.RELEASE_TOKENrepo secret (PAT withrepo+workflowscope) before the first release PR.release.yaml:release,prerelease,major,minor,patch,alpha,beta,rc.doc/Jupyter Book directory (left in place by this PR).Notes
mainwill produceversioned_docs/version-<X.Y.Z>/,versioned_sidebars/,versions.json, and fliplastVersionautomatically — no manual snapshot is committed in this PR.docusaurus.config.tsand the release workflow currently referencechrislupp/Philote-Python; the actual remote isMDO-Standards/Philote-Python. Update the org/URL fields if you want the edit links and release workflow URLs to point at the canonical repo.