Skip to content

feat: Documentation for WaveSpectra.jl - #39

Open
baez-rafael wants to merge 17 commits into
mainfrom
docs-29
Open

baez-rafael wants to merge 17 commits into
mainfrom
docs-29

Conversation

@baez-rafael

@baez-rafael baez-rafael commented Jun 1, 2026 •

Copy link
Copy Markdown
Member

🚨 Checklist

💔 Thanks!

PR Description

  • Branch dedicated to writing the documentation for the WaveSpectra.jl package.

@codecov

codecov Bot commented Jun 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 9 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

baez-rafael and others added 11 commits June 2, 2026 08:05
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
… sections. Figured out filtering for multiple functions using autodocs.
…cs to avoid breaking in case of new release.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Comment thread docs/make.jl
Comment on lines +35 to +38
repo = "github.com/JuliaOceanWaves/WaveSpectra.jl.git",
devbranch = "main",
push_preview = true,
versions = ["latest" => "v^", "v#.#"],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
repo = "github.com/JuliaOceanWaves/WaveSpectra.jl.git",
devbranch = "main",
push_preview = true,
versions = ["latest" => "v^", "v#.#"],
repo = "github.com/JuliaOceanWaves/WaveSpectra.jl.git",
devbranch = "main",
push_preview = true,
versions = ["latest" => "v^", "v#.#"]

Comment thread docs/make.jl
bib = CitationBibliography(joinpath(@__DIR__, "references.bib"))

function regex_match(regex, x)
return !isnothing(match(regex, string(x)))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
return !isnothing(match(regex, string(x)))
return !isnothing(match(regex, string(x)))

Comment thread docs/make.jl
Comment on lines +17 to +31
sitename = "WaveSpectra.jl",
format = Documenter.HTML(
prettyurls = get(ENV, "CI", "false") == "true",
assets = String["assets/citations.css",
"assets/images.css"],
),
modules = [WaveSpectra],
pages = [
"Home" => "index.md",
"Quickstart" => "quickstart.md",
"Basic Functionality" => "basic_func.md",
"Extended Funcitonality" => "extended_func.md",
"API" => "api.md",
],
plugins = [bib],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
sitename = "WaveSpectra.jl",
format = Documenter.HTML(
prettyurls = get(ENV, "CI", "false") == "true",
assets = String["assets/citations.css",
"assets/images.css"],
),
modules = [WaveSpectra],
pages = [
"Home" => "index.md",
"Quickstart" => "quickstart.md",
"Basic Functionality" => "basic_func.md",
"Extended Funcitonality" => "extended_func.md",
"API" => "api.md",
],
plugins = [bib],
sitename = "WaveSpectra.jl",
format = Documenter.HTML(
prettyurls = get(ENV, "CI", "false") == "true",
assets = String["assets/citations.css",
"assets/images.css"]
),
modules = [WaveSpectra],
pages = [
"Home" => "index.md",
"Quickstart" => "quickstart.md",
"Basic Functionality" => "basic_func.md",
"Extended Funcitonality" => "extended_func.md",
"API" => "api.md"
],
plugins = [bib]

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants