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

CI failures due to docstrings for @autoinfiltrate #1468

Closed
jlchan opened this issue May 15, 2023 · 4 comments · Fixed by #1473
Closed

CI failures due to docstrings for @autoinfiltrate #1468

jlchan opened this issue May 15, 2023 · 4 comments · Fixed by #1473
Assignees
Labels
bug Something isn't working

Comments

@jlchan
Copy link
Contributor

jlchan commented May 15, 2023

Looks like there are some CI failures due to docstrings for @autoinfiltrate. https://github.com/trixi-framework/Trixi.jl/actions/runs/4982571112/jobs/8918427933?pr=1458

[ Info: CrossReferences: building cross-references.
┌ Error: no doc found for reference '[`@autoinfiltrate`](@ref)' in src/development.md.
└ @ Documenter.CrossReferences ~/.julia/packages/Documenter/H5y27/src/Utilities/Utilities.jl:32
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
ERROR: LoadError: `makedocs` encountered an error (:cross_references). Terminating build before rendering.
Stacktrace:
 [1] error(s::String)
...

Originally posted by @jlchan in #1460 (comment)

@jlchan jlchan changed the title CI failures due to docstrings for @autoinfiltrate? https://github.com/trixi-framework/Trixi.jl/actions/runs/4982571112/jobs/8918427933?pr=1458 CI failures due to docstrings for @autoinfiltrate May 15, 2023
@jlchan jlchan added the bug Something isn't working label May 16, 2023
@jlchan
Copy link
Contributor Author

jlchan commented May 16, 2023

Looks like these failures may have been spurious, I don't see them any longer in #1458...

@jlchan
Copy link
Contributor Author

jlchan commented May 16, 2023

Never mind, they are still occurring in #1467

@sloede
Copy link
Member

sloede commented May 16, 2023

Does anyone understand what's wrong with this ref:

you can use the (non-exported) [`@autoinfiltrate`](@ref) macro

If I change this to

 you can use the (non-exported) `@autoinfiltrate` macro 

then it works and the entry in the API section is generated correctly:
image

I just don't get why it doesn't manage to get the ref correctly...

@jlchan
Copy link
Contributor Author

jlchan commented May 16, 2023

Just to make sure, does Documenter.jl generate references properly in other warning blocks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants