Add GitHub Pages documentation site#8
Merged
Conversation
Add a documentation site modeled after the R CausalImpact tutorial. - mkdocs.yml: MkDocs Material config with sidebar nav (5 pages) - docs/index.md: tutorial with code examples, plot, summary/report output - docs/api.md: CausalImpact/ModelOptions/CausalImpactResults reference - scripts/generate_docs_assets.py: deterministic plot generation (seed=42) - tests/test_docs_assets.py: 9 tests (normal/boundary/error cases) - .github/workflows/docs.yml: build + deploy to GitHub Pages on main push - pyproject.toml: add [docs] optional-dependencies
YuminosukeSato
added a commit
that referenced
this pull request
Mar 23, 2026
Add GitHub Pages documentation site
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
What changed
mkdocs.ymldocs/index.mddocs/api.mdCausalImpact,ModelOptions,CausalImpactResultsdocs/images/.gitkeepscripts/generate_docs_assets.pycausal_impact_plot.pngwith fixed seed (headless Agg backend)tests/test_docs_assets.py.github/workflows/docs.ymlpyproject.toml[docs]optional-dependencies (mkdocs-material, pymdown-extensions).gitignoresite/anddocs/images/*.pnguv.lockArchitecture
Test plan
pytest tests/test_docs_assets.py -v— 9/9 passedruff check— all checks passedmkdocs build --strict— builds without warnings or errorsNotes for reviewers
docs/index.mdembeds actualci.summary()andci.report()output captured from a real run (seed=42, niter=1000). These are static code blocks, not dynamically generated.migration-from-r.md,migration-from-tfp.md,compatibility-matrix.md) are included in the nav as-is with no modifications.main. PR builds runmkdocs build --strictas a validation step without deploying.