Skip to content

Comments

Fix citations in documentation#414

Open
SachinDurairaj06 wants to merge 6 commits intoarviz-devs:mainfrom
SachinDurairaj06:fix-arvizjl-citations
Open

Fix citations in documentation#414
SachinDurairaj06 wants to merge 6 commits intoarviz-devs:mainfrom
SachinDurairaj06:fix-arvizjl-citations

Conversation

@SachinDurairaj06
Copy link

This PR enables citation support in ArviZ.jl documentation by adding
DocumenterCitations wiring and a references.bib file, following the
setup used in PosteriorStats.jl.

Fixes #405

@sethaxen
Copy link
Member

sethaxen commented Jan 5, 2026

Thanks @SachinDurairaj06 for the PR! The approach looks right, but the Documenter workflow is failing because DocumenterCitations needs to be added to the docs environment (docs/Project.toml).

@SachinDurairaj06
Copy link
Author

SachinDurairaj06 commented Jan 5, 2026

Thanks for the review and the clarification.

I’ve updated docs/Project.toml to include DocumenterCitations in the docs environment, which should fix the documentation workflow failure. The change has been pushed to this PR.

Please let me know if anything else needs adjustment. @sethaxen

@SachinDurairaj06
Copy link
Author

@sethaxen can u approve the checks to verify the fix

@SachinDurairaj06
Copy link
Author

@sethaxen I’ve addressed the documentation failure by adding DocumenterCitations.
The remaining failures appear to be in SampleChains / extension tests and may be unrelated to the doc changes.
Please let me know if you’d like me to investigate any of these further.

@sethaxen
Copy link
Member

@sethaxen I’ve addressed the documentation failure by adding DocumenterCitations.
The remaining failures appear to be in SampleChains / extension tests and may be unrelated to the doc changes.
Please let me know if you’d like me to investigate any of these further.

No need to worry about the extension tests since this PR doesn't touch those, but I'm seeing that the docs build is still failing. Are you able to instantiate the environment and build the docs locally?

@SachinDurairaj06
Copy link
Author

@sethaxen I have fixed it again ,can u approve the checks to verify the fix

@SachinDurairaj06
Copy link
Author

@sethaxen I can confirm the docs now build locally with
julia --project=. make.jl
after adding DocumenterCitations to docs/Project.toml and fixing the plugins configuration.
Please let me know if you’d like me to investigate the remaining CI failures or adjust anything further.

@sethaxen sethaxen closed this Feb 2, 2026
@sethaxen sethaxen reopened this Feb 2, 2026
@sethaxen
Copy link
Member

sethaxen commented Feb 3, 2026

@SachinDurairaj06 I've merged main into your branch to resolve the doctest failures with the new ArviZExampleData v0.3, but I'm still seeing numerous errors in the docs build.

e.g. here

Error: Key "VehtariSimpson2021" not found in entries from /home/runner/work/ArviZ.jl/ArviZ.jl/docs/src/references.bib

This seems to be because the references.bib needs also the references from PSIS.jl, which we also re-export. You should be able to just add the entries from https://github.com/arviz-devs/PSIS.jl/blob/929ac405c8896ade5a9bb7ecfc17cb2dcc7a2dfb/docs/src/references.bib

And a bunch of ones like this (e.g. here):

Error: expand_citation (rec): No destination for key="Hyndman1996" → unlinked text "1"
Error: expand_citation (rec): No destination for key="ChenShao1999" → unlinked text "Chen and Shao [2]"
...

I don't know what the 2nd set of errors is caused by, but the first set make sense, and I'm surprised the docs build succeeds locally for you.

@SachinDurairaj06
Copy link
Author

Thanks for the detailed explanation — that makes sense.
I’ll add the missing BibTeX entries from PSIS.jl/docs/src/references.bib into docs/src/references.bib in ArviZ.jl and push an update shortly. I’ll also check whether the expand_citation errors persist once the missing references are included

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.

Citations not working on ArviZ.jl webpage

2 participants