Import changes from JuliaQuantumControl/QuantumCitations.jl #2
Conversation
Refactor the code for rendering both citations and the bibliography such that the rendered text is obtained from a `format_citation` and `format_bibliography_entry` function, respectively. Moreover, in the bibliography, the citation key is rendered via `format_bibliography_key`. These functions provide hooks for a user to completely customize the rendering. For example, a user could decide to use the [`alpha` citation style](https://www.bibtex.com/s/bibliography-style-base-alpha/) by defining an appropriate `format_citation` and `format_bibliography_key` function.
Citations are numbered in the order in which they appear (according to the navigation)
At some point, the modifications to the .bib file should be reverted and a better handling of math / protected strings in titles should be implemented.
This is a workaround for the problem described in https://discourse.julialang.org/t/running-makedocs-overwrites-repl-docstrings/
|
Ah, thanks! That's exactly what I had in mind (and I was just about to do the same). I can add some more commits to this to further adapt documentation and CI as necessary. If we're keeping the numeric style as the default, it shouldn't be that much work. Once we're happy with this branch, I would recommend merging it manually with |
|
Yep, I won't add more commits until tomorrow, at least the last one does the rename (blind search and replace so haven't checked everything). I believe CI is mad because of the UUID now (should be changed back too). Also, I hope it is okay to remove some of the JuliaQuantum infrastructure now that it is maintained under JuliaDocs? My computer grounded to a halt when precompiling QuantumTestUtils so would be happy to get rid if that, for example. But we can make these changes gradually in separate PRs. Would be good to update the docs before merge though, so it doesn't say "DocumenterCitations is a fork if DocumenterCitations" etc. |
goerz
force-pushed
the
fe/JuliaQuantumControl/QuantumCitations.jl
branch
from
f03aa99
to
8c3c4cd
Compare
Best not to depend on QuantumControlTestUtils
Yes, I changed the UUID back to the original one. Together with some other fixes, the tests now run through.
Yes, totally. We should get rid of any QuantumControl org-specific tooling. I removed the dependency, but copied some of that tooling into the
That definitely works for me, and should speed up the merge quite a bit. It's straightforward to customize for any user (just add a Incidentally, I think I changed the minimum Julia version from 1.4 to 1.6 (since everything in the QuantumControl org has a minimum of 1.6), so that's also a breaking change. The CI test matrix only does Julia 1.6 on Linux right now. It would probably be good to extend that to Julia 1.9 and maybe also other platforms.
Definitely. Give me a few days to rewrite the README and documentation a bit to something more appropriate. I don't think we have to rush the merge, but it shouldn't take very long, either. Do we need to do something to get the gh-pages deployment working? That might have to wait until the PR is merged into |
The failure on Windows seems more like a "syntax error" in Unfortunately, I haven't touched a Windows system in 20 years, so I'm not quite sure what exactly is wrong there. Any ideas? |
|
Windows shell syntax is impossible to get right with quotes, but you can use julia as the shell instead, see https://discourse.julialang.org/t/tip-use-julia-as-custom-shell-in-github-actions/53377 |
|
Codecov seems activated, just don't have coverage for the master branch to compare with. I added an SSH deploy key for Documenter. |
|
Merged in 3b20824, docs still needs fixing, but thought it would be easier to do it afterwards after all. |
|
Ok, sounds good! I'll start another PR on that… |
This rebases https://github.com/JuliaQuantumControl/QuantumCitations.jl onto https://github.com/JuliaDocs/DocumenterCitations.jl
Should revert the rename before merging at least.