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.

Sign up for GitHub

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

Jump to bottom

Use SphinxPostTransform to avoid having to run sphinx twice. #219

Merged
merged 111 commits into from
Dec 28, 2020
Merged

Use SphinxPostTransform to avoid having to run sphinx twice. #219

merged 111 commits into from
Dec 28, 2020

Conversation

mcmtroffaes
Copy link
Owner

Still work in progress but for now it looks like this will be working. Quite few tests are failing, I'll be working through these and then hopefully some kind folks could help testing, because this is a pretty major overhaul.

Also see discussion at #214.

@mcmtroffaes
Switch to post transform (warning: with this patch, the implementatio…
676c643 
…n is broken, WIP).
@mcmtroffaes
Update roles.py
80f298a
@mcmtroffaes
Some small fixes.
0144899
@mcmtroffaes
Fix subtle bug.
65288fb
@mcmtroffaes
Some fixes so resolve_xref gets called properly.
1762797
@mcmtroffaes
Try to generate links.
f6c6210
@mcmtroffaes
Fix flake8 errors.
6d37b5f
@mcmtroffaes
Remove all json files.
eaa648e
@mcmtroffaes
Generate proper labels and store them with citation data.
aca4266
@mcmtroffaes
Merge branch 'feature/posttransform' of https://github.com/mcmtroffae…
f6af814 
…s/sphinxcontrib-bibtex into feature/posttransform
@mcmtroffaes
Correct label node of citations.
8c38e5d
@mcmtroffaes
Fixing some tests.
8b11d4a
@mcmtroffaes
Gracefully handle bibtex key not being found.
aee6922
@mcmtroffaes
Fix another test.
a0b9ba2
@mcmtroffaes
Use dict as oset (since we require Python 3.6+ anyway).
23294df
@mcmtroffaes
Fix flake warning.
7816e50
@mcmtroffaes
Use named tuples for data about citations and citation references.
abe602d
@mcmtroffaes
Fix get_label_from_key.
ee0de1f
@mcmtroffaes
Fix duplicate label test.
5b1d4b6
@mcmtroffaes
Use check_consistency to set up all citation nodes (this must happen …
de0bb9c 
…before the post transform as post transforms also operate on a per document level)..
@mcmtroffaes
Fix issue with ordering.
58ab2e3
@mcmtroffaes
Some more small fixes.
b025a32
@mcmtroffaes
Style fix.
f7094c7
@mcmtroffaes
Small flake8 fixes.
d0ccdee
@mcmtroffaes
Correct citation node ids.
aa9223d
@mcmtroffaes
Fix test regexp.
68f0955
@mcmtroffaes
Fix header bug.
b540076
@mcmtroffaes
Minor fixes in test.
cdb4428
@mcmtroffaes
Update test_issue61.py
421a2c0
@mcmtroffaes
No need to specify encoding in filter test.
3590efb
@mcmtroffaes
Rework local bibliography tests to make use of the regular expressions.
0447513
@mcmtroffaes
Rename for clarity.
d9559bd
@mcmtroffaes
Remove unused constant.
e0e20d2
@mcmtroffaes
Use labels and titles for autodoc test.
feca0db
@mcmtroffaes
Fix flake8 errors.
c5faeec
@mcmtroffaes
Use regexp match groups for latex test.
a316e73
@mcmtroffaes
Replace id by text in backrefs test.
2186850
@mcmtroffaes
Remove unneeded line, small update to bib file to ensure logical sort…
7718ae8 
…ing.
@mcmtroffaes
Update common.py
6ec837b
@mcmtroffaes
Use note_explicit_target to generate bibliography ids, refactor bibli…
eb142de 
…ography data so (docname, id) is the key rather than the id (since ids are only unique within docnames).
@mcmtroffaes
Fix flake8 warning.
fc9a1fb
@mcmtroffaes
Store formatted entry in citation during resolve stage, to avoid havi…
6cbd5c9 
…ng to look it up twice.
@mcmtroffaes
Fix test.
63fc9ee
@mcmtroffaes
Fix some type warnings.
b454651
@mcmtroffaes
Gracefully handle case when bibliography directive has a bib file tha…
cdbc00d 
…t is not listed in the bibtex_bibfiles setting.
@mcmtroffaes
Update .gitignore
52317fe
@mcmtroffaes
Ensure ids will not clash, now using also note_explicit_target for ci…
4247c3e 
…tation nodes.
@mcmtroffaes
Rename test file/folder for clarity.
c0edcdd
@mcmtroffaes
Small refactoring.
ab7e2c9
@mcmtroffaes
Generate citation node of the right class immediately, to ensure id i…
0d9b5bb 
…s preserved.
@mcmtroffaes
Fix tests.
d18e3c9
@mcmtroffaes
Minor fixes.
2fa2c62
@mcmtroffaes
Copy link
Owner Author

Found an issue with duplicate ids (actually this had been a problem all along, the new design just flagged it more explicitly), this has now been fixed.

@mcmtroffaes mcmtroffaes merged commit 74b94e9 into develop Dec 28, 2020
@choldgraf
Copy link

wahoo! 🚀

This was referenced Dec 28, 2020
Merged
Closed
@mcmtroffaes mcmtroffaes deleted the feature/posttransform branch December 29, 2020 18:11
@matthewfeickert matthewfeickert mentioned this pull request Jan 14, 2021
Merged
4 tasks
@matthewfeickert
Copy link

This might still be a bit rough around the edges, but the full test suite is now passing. Mind giving this a spin in the next week or so, or even doing a code review if it is up your alley, its a big patch and more eyes would be appreciated? This new design uses the resolve phase to generate the full citation information, and then generates the actual citation and citation reference nodes in a post transform, so everything works with just a single sphinx run.

And merry Christmas! :-)

Sorry to have missed this while I was on holiday @mcmtroffaes, but thank you very much for all of this nice work and being so responsive and considerate to people's requests. Along with everyone else I'm happy to report that this is working great. 🚀 Thanks! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mcmtroffaes @chrisjsewell @choldgraf @jedbrown @matthewfeickert