Add "works citing" list to the "citation" page of the docs#433
Add "works citing" list to the "citation" page of the docs#433jwreep wants to merge 12 commits intowtbarnes:mainfrom
Conversation
| @article{badnell_radiative_2006, | ||
| title = {Radiative {{Recombination Data}} for {{Modeling Dynamic Finite-Density Plasmas}}}, | ||
| author = {Badnell, N. R.}, | ||
| keywords = {cited}, |
There was a problem hiding this comment.
What's the reason for adding these?
There was a problem hiding this comment.
Trying to properly split the references. Sphinx apparently just merges multiple files into one list, so I did this to try to filter between the works cited in the docs and the works using fiasco. Still a draft PR because I can't quite get it right yet!
There was a problem hiding this comment.
Oh I see. I assumed it would differentiate between the different files.
docs/works_citing.rst
Outdated
| .. bibliography:: works_citing.bib | ||
| :filter: keywords % "citing" | ||
| :style: plain | ||
| :all: |
There was a problem hiding this comment.
The GH Actions docs build is failing with a warning because it says that the :filter: directive overrides :all:. Can we just drop :filter: and only use :all:? Or vice versa?
There was a problem hiding this comment.
I'll try that. I thought they should be able to be used together, but clearly not!
There was a problem hiding this comment.
If you can't get it to work, we can always just ignore the warning. Looking at the RTD preview, it seems like it renders just fine
There was a problem hiding this comment.
Both ways rendered correctly in the docs, but both failed the CI action. Not sure why! I don't have a great grasp of sphinx, and google is suggesting a more substantial change to fix this, but I'd probably be making a mess since I don't really understand the suggestions.
Any ideas are welcome here!
There was a problem hiding this comment.
Can we ignore the warning in a way that doesn't affect future PRs? I don't want to ignore it for this one, and then have all future PRs fail because of this relatively minor change to the docs.
|
@wtbarnes Fixed it! There was a command in the tox.ini file that was causing the error, which I've changed now. I don't see any major differences to the other docs pages which could've potentially been affected, but please have a check yourself as well. Two pairs of eyes and all that. I'd potentially like to double check whether adding the keywords to the citations is critical as it stands, but that at least differentiates the two sets of bibliographies. |
jwreep
changed the title
|
Could you revert that tox change and then try again? tox recently had a release (4.42) that broke a lot of stuff and then subsequently put out several releases (up to 4.46 now I think) that fixed a lot of these bugs. I suspect that it wasn't the actual change you made that fixed things, but merely the fact that it reran the build with the new (not broken) tox install. |
This reverts commit 69fbd6a.
|
Fair enough. Reverted and re-running. |
|
This all looks good to me if you are happy with it. Thanks again for adding this! |
2 participants
Partially addresses #429
Updates citation to latest version
Fixes sphinx warning with citation to DuFresne+ 2024
Changes
gallerycommand for building examples in the docsI haven't automated scraping of the bib file, but this should be a start.