Issue 7: Documentation#19
Conversation
Introduces a full documentation suite under the docs/ directory, including Project.toml, build scripts, a Quarto tutorial notebook, API reference, custom assets (logo, CSS, JS), and a detailed index page. Also updates a comment in src/forecasting.jl for clarity. This enhances usability and onboarding for users and developers.
There was a problem hiding this comment.
Pull Request Overview
This pull request sets up comprehensive documentation infrastructure for the NowcastAutoGP.jl Julia package using Documenter.jl with a custom Material Design-inspired theme. The PR introduces documentation configuration, content structure, theming enhancements, and a detailed tutorial demonstrating the package's capabilities for epidemiological forecasting with nowcasting.
- Documentation build infrastructure with dependencies and configuration files
- Custom Material Design theme with CSS styling and JavaScript enhancements
- Comprehensive tutorial showing real-world usage with NHSN COVID-19 hospitalization data
- API reference documentation with automatic function/type documentation
Reviewed Changes
Copilot reviewed 12 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/Project.toml | Defines documentation dependencies and links to local package |
| docs/make.jl | Configures Documenter.jl build process with custom theme and site structure |
| docs/src/index.md | Homepage with package introduction and installation instructions |
| docs/src/api.md | API reference page for automatic documentation generation |
| docs/src/assets/material-theme.css | Material Design-inspired CSS theme for documentation site |
| docs/src/assets/material-theme.js | JavaScript enhancements for interactive UI features |
| docs/vignettes/tutorial.qmd | Comprehensive Quarto tutorial with real NHSN data examples |
| docs/src/vignettes/tutorial.md | Converted tutorial in Markdown format for documentation site |
| src/transformations.jl | Added documentation strings for internal transformation functions |
| src/forecasting.jl | Minor comment clarification update |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #19 +/- ##
=======================================
Coverage 93.02% 93.02%
=======================================
Files 5 5
Lines 86 86
=======================================
Hits 80 80
Misses 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 17 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Corrects the function name from _get_offet to _get_offset in get_transformations and its documentation reference to ensure proper function calls and accurate documentation.
This pull request sets up documentation for the
NowcastAutoGP.jlJulia package using Documenter.jl and introduces a custom Material Design-inspired theme for the docs. The changes include configuration files, a documentation build script, an API reference page, a homepage, a JavaScript file for UI enhancements, and supporting files.The most important changes are:
Documentation infrastructure:
Project.tomlin thedocs/directory specifying documentation and plotting dependencies, and linking to the localNowcastAutoGPpackage for building docs.make.jlto configure and build the documentation site with Documenter.jl, including deployment settings and site structure.Content and structure:
index.md) introducing the package, installation instructions, and links to further resources.api.md) that automatically documents all exported functions and types from the package.Theming and user experience:
material-theme.js) to enhance documentation UI with smooth scrolling, ripple effects, sidebar improvements, code copy buttons, scroll-to-top, syntax highlighting, and more..gitignorefor vignette outputs and Quarto-generated files.