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

Update Documenter version #137

Merged
merged 2 commits into from
Sep 20, 2023
Merged

Conversation

oscardssmith
Copy link
Member

@fingolfin this might also help with the docs

@fingolfin
Copy link
Contributor

I don't think that's it. Rather we need to set some doctest metadata. I can submit a PR for this when I am back at my computer; it's a bit too annoying to debug this from my iPad ;-)

@oscardssmith
Copy link
Member Author

lets see if the combination works.

@fingolfin
Copy link
Contributor

Seems to work. The remaining failure is genuine; the comments in the output were manually added. One could discard them (but that would be a loss), or change the jldoctest into a plain julia block; or perhaps employ a doctest filter...

@oscardssmith oscardssmith merged commit 177dd94 into master Sep 20, 2023
3 of 4 checks passed
@oscardssmith oscardssmith deleted the oscardssmith-update-documenter branch September 20, 2023 17:26
@oscardssmith
Copy link
Member Author

Can you add the PR to make this have a doctest filter (since I don't really understand what that is)

@fingolfin
Copy link
Contributor

See https://documenter.juliadocs.org/stable/man/doctests/#Filtering-Doctests -- but sure, I can make a PR

@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Primes = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"

[compat]
Documenter = "~0.20"
Documenter = "~1.0"
Copy link
Member

Choose a reason for hiding this comment

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

You probably wanted to use

Documenter = "1.0"

With ~1.0 you won't be able to upgrade to v1.1.0

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.

3 participants