Add unified POPS-UQ documentation site (Sphinx + Furo) - #1
Merged
Conversation
Scaffold a language-neutral docs site that documents the Python (popsregression) and Julia (POPSRegression.jl) implementations side by side, intended to eventually subsume the per-package sites and serve as the POPS-UQ org landing page. - Sphinx + Furo theme with MyST Markdown, sphinx-design (synced Python/Julia tabs, feature grids), sphinx-copybutton and MathJax - Pages: landing, installation, quickstart, theory (misspecification- aware regression), examples (Python simple, Julia ACE, Julia MD), and a combined API reference - GitHub Actions workflow to build (warnings-as-errors) and deploy to GitHub Pages from main - Custom POPS logo and styling Examples may be written in either language and tagged per page; the structure is designed to grow with more domains and languages.
Updated section headings to clarify the problem and concept of POPS.
tomswinburne
marked this pull request as draft
June 14, 2026 22:19
Convert the site from Sphinx/Furo to Material for MkDocs, matching the look of the existing popsregression docs for a consistent POPS-UQ style. - Replace conf.py/Furo with mkdocs.yml (Material, indigo palette, synced Python/Julia content tabs, MathJax via arithmatex, search) - Streamline the landing page: drop the hero and marketing-style section headers, lead with a concise intro, install cards and quick-start tabs - Fold the scikit-learn pipeline usage directly into the Python example (no standalone section) and remove it from the quick start - Update the GitHub Actions workflow to build with 'mkdocs build --strict' and deploy to Pages from main only
tomswinburne
marked this pull request as ready for review
July 1, 2026 00:07
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.
Summary
A new, language-neutral documentation site that documents the Python (
popsregression) and Julia (POPSRegression.jl) implementations of POPS side by side. Built with Sphinx + Furo (the same stack as the quests site), it is intended to grow into the POPS-UQ org landing page and eventually subsume the per-package docs sites.Examples may be written in either language (e.g. a simple Python regression and a Julia ACE fit) and are tagged per page; the structure is designed to add more domains and languages over time.
What's included
Pages
pip/ JuliaPkg.add, with a "which one should I use?" tablefit/predicttabs and a table mapping the two APIs' parametersTooling
sphinx-design(synced tabs + cards),sphinx-copybutton, MathJaxDocumentationGitHub Actions workflow: builds on PRs (warnings-as-errors) and deploys to GitHub Pages only frommainVerification
sphinx-build -W --keep-goingpasses with zero warningsNote on hosting
The final target — replacing
https://pops-uq.github.io/— is the org root, which GitHub serves only from a repo namedpops-uq.github.io. Pages from this.githubrepo would publish athttps://pops-uq.github.io/.github/(a subpath). Everything here is path-relative, so movingdocs/(and the workflow) into apops-uq.github.iorepo later is a clean copy.https://claude.ai/code/session_01VoFM4hMn4hAbCfG39rYkiG
Generated by Claude Code