Skip to content
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

Remove repo argument to makedocs #450

Merged
merged 3 commits into from
Jan 9, 2024
Merged

Remove repo argument to makedocs #450

merged 3 commits into from
Jan 9, 2024

Conversation

gdalle
Copy link
Collaborator

@gdalle gdalle commented Jan 9, 2024

Avoids the following warning by letting Documenter infer the repository instead of giving repo::String:

┌ Warning: Unable to determine the repository root URL for the navbar link.
│ This can happen when a string is passed to the `repo` keyword of `makedocs`.
│ 
│ To remove this warning, either pass a Remotes.Remote object to `repo` to completely
│ specify the remote repository, or explicitly set the remote URL by setting `repolink`
│ via `makedocs(format = HTML(repolink = "..."), ...)`.
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/1HwWe/src/html/HTMLWriter.jl:707

The alternative would be to provide an explicit Remotes.GitHub, Remotes.GitLab or Remotes.URL depending on the host (see the release notes https://documenter.juliadocs.org/v1.0.0/release-notes/).
Not sure which is best.

Is this enough to fix #430?

Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e55f550) 93.80% compared to head (4f2af8f) 93.80%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #450   +/-   ##
=======================================
  Coverage   93.80%   93.80%           
=======================================
  Files          24       24           
  Lines         742      742           
=======================================
  Hits          696      696           
  Misses         46       46           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@oxinabox oxinabox left a comment

Choose a reason for hiding this comment

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

Makes sense

templates/docs/make.jl Outdated Show resolved Hide resolved
test/fixtures/AllPlugins/docs/make.jl Outdated Show resolved Hide resolved
Copy link

@goerz goerz left a comment

Choose a reason for hiding this comment

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

LGTM!

@gdalle gdalle merged commit e691878 into master Jan 9, 2024
13 checks passed
@gdalle gdalle deleted the gd/documenter1 branch January 9, 2024 15:30
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.

Support Documenter.jl v1.0
3 participants