-
Notifications
You must be signed in to change notification settings - Fork 10
Add Documentation #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Documentation #238
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation to the RegularizedOptimization.jl package, including new documentation files, bibliography support, and algorithm descriptions.
- Adds detailed package documentation with mathematical formulations and regularizer explanations
- Introduces bibliography support with citation references for academic publications
- Creates algorithm documentation explaining different optimization methods available
Reviewed Changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/index.md | Adds comprehensive package documentation including overview, regularizers table, installation instructions, and API explanations |
| docs/src/algorithms.md | New file documenting available optimization algorithms with mathematical formulations and reference table |
| docs/src/bibliography.md | New bibliography page for citation management |
| docs/references.bib | Bibliography file containing academic references for the algorithms |
| docs/make.jl | Updates documentation build configuration to include citations support and new page structure |
| docs/Project.toml | Adds DocumenterCitations dependency and updates version constraints |
| docs/src/tutorial.md | Removes placeholder tutorial content |
| docs/src/reference.md | Removes contents section from reference page |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| doctest = true, | ||
| # linkcheck = true, | ||
| strict = true, | ||
| warnonly = false, |
Copilot
AI
Sep 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The strict = true option was replaced with warnonly = false. However, warnonly is a newer Documenter.jl option. Consider using strict = [:missing_docs] or similar for more granular control over documentation strictness.
| warnonly = false, | |
| strict = [:missing_docs], |
|
|
||
| [compat] | ||
| Documenter = "~0.25" | ||
| Documenter = "1" |
Copilot
AI
Sep 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The version constraint for Documenter changed from ~0.25 to 1, which is a major version jump. Consider using 1.0 to be more explicit about the minimum required version, and ensure compatibility with the current codebase.
| Documenter = "1" | |
| Documenter = "1.0" |
Co-authored-by: Dominique <[email protected]>
|
@dpo you can review again. |
dpo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super, merci beaucoup.
https://jso.dev/RegularizedOptimization.jl/previews/PR238/
A few comments :