-
-
Notifications
You must be signed in to change notification settings - Fork 398
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
[docs] add DocumenterCitations #3596
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3596 +/- ##
==========================================
- Coverage 98.39% 98.29% -0.11%
==========================================
Files 38 38
Lines 5687 5686 -1
==========================================
- Hits 5596 5589 -7
- Misses 91 97 +6 ☔ View full report in Codecov by Sentry. |
cc @goerz any ideas about this? |
I have a vague memory of having seen something like that before… I think it might have been if you forget to have a (canonical) bibliography block? That is, there’s nothing for the reference to link to? Are you using the latest version? Because I also recall doing something do give a clear error message in such a situation (or maybe it was just something I wanted to do and then forgot to follow up on) |
Yip. We're using
|
Hard to say… I tried to reproduce it locally after checking out that PR branch, with
but that never gets to the error with the bibliography, as it fails with during the doctests/tutorials with
Do you have any special instructions for building the documentation? I was trying this on my MacBook; should I use my Linux workstation instead? (I'd maybe recommend creating a If I can reproduce it, I'll see if I can figure out what's going on with the citation. |
It's not uncommon for that doctest to fail on Mac. But things pass on CI so I haven't spent too much time looking into it. I'd just delete the OPF line from Line 343 in cecc5ba
as well as the file itself. |
I was still having trouble on my MacBook, so I just switched to Linux. Took a while to run through the build, but it finished now, and I'm not seeing any errors: Everything seems fine when I look at the rendered HTML, too. Both the citations and the bibliography are there. As a matter of style, I would probably recommend putting the Bibliography on a separate page at the end of the documentation (especially if the list of references grows large), but that's up to you. |
What if you run with Line 557 in cecc5ba
Yeah will do. @blegat was just trying this as a proof of concept. |
Sure, I'll try the edit: still working fine |
For some reason 50c3859 fixed it... |
😮 I guess it's because we shouldn't use the same plugin instance for the pdf and the html, good catch |
Just tried one with an accent with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Can fix the various other references over time.
The escaped version is fully supported, but Unicode should work as well, both for HTML and TeX/PDFs. I’ve been using unicode in my .bib files for years, and haven’t had any problems. Officially, bibtex is still “ascii-only”, so I don’t know why it works, but any installation of LaTeX on Linux and macOS I’ve used since at least 2015 just does the right thing. |
@goerz Thanks! I guess both can be used then |
I always found it quite difficult and time consuming to manage citations and ensure a uniform look. Just found this DocumenterCitations which seems promising so let's see how it looks. I started with just a few citations as a proof of concept.
Preview https://jump-dev.github.io/JuMP.jl/previews/PR3596