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.

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

Bibliographies #1058

Merged
merged 48 commits into from
Mar 11, 2024
Merged

Bibliographies #1058

merged 48 commits into from
Mar 11, 2024

Conversation

fredrik-bakke
Copy link
Collaborator

@fredrik-bakke fredrik-bakke commented Mar 5, 2024

Adds citation support using a biblatex file and pybtex, reactors most current citations to use it, and adds a small guide to explain how to use it.

Resolves #957.

@fredrik-bakke fredrik-bakke added documentation Improvements or additions to documentation enhancement New feature or request website labels Mar 5, 2024
@fredrik-bakke fredrik-bakke marked this pull request as ready for review March 6, 2024 22:01
@fredrik-bakke
Copy link
Collaborator Author

This one's ready for review :) Please build the website locally to see how the new references look. Note that I have not written any documentation yet.

@fredrik-bakke
Copy link
Collaborator Author

fredrik-bakke commented Mar 11, 2024

I've resolved all but your comment regarding changing the HTML backend, which I will do tonight. In the process of reviewing this PR, I found a series of other mistakes in the citations and bibliography file too that are now fixed. @VojtechStep

EDIT: It's resolved now too

@VojtechStep
Copy link
Collaborator

Note that while disabling the check-ast pre-commit hook silences the CI, running the preprocessor still fails on Python 3.8, it's just at runtime and (for some reason) silent - the website build finishes, but the preprocessor never runs. We should reinstate the check-ast hook and make sure our scripts actually run on 3.8 @fredrik-bakke

@VojtechStep
Copy link
Collaborator

It seems that just removing the newlines introduced in f-strings solves this. It looks like this bug in autopep8 with Python 3.12: hhatto/autopep8#712

@fredrik-bakke
Copy link
Collaborator Author

Note that while disabling the check-ast pre-commit hook silences the CI, running the preprocessor still fails on Python 3.8, it's just at runtime and (for some reason) silent - the website build finishes, but the preprocessor never runs. We should reinstate the check-ast hook and make sure our scripts actually run on 3.8 @fredrik-bakke

Python amirite

@fredrik-bakke
Copy link
Collaborator Author

Thanks for catching this before a merge. Of course it didn't fail when I tested locally because I run a python version that is compatible with the formatting

Copy link
Collaborator

@VojtechStep VojtechStep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 👌; I think after the f-string are fixed this one is ready to be merged

scripts/preprocessor_citations.py Outdated Show resolved Hide resolved
scripts/preprocessor_citations.py Show resolved Hide resolved
scripts/preprocessor_citations.py Outdated Show resolved Hide resolved
scripts/preprocessor_git_metadata.py Outdated Show resolved Hide resolved
@VojtechStep
Copy link
Collaborator

One last request - could you log which file included a dangling citation/reference? Adding chapter['path'] to the logged message should be enough.

@fredrik-bakke
Copy link
Collaborator Author

Anything else? 🤓

@VojtechStep
Copy link
Collaborator

Nope, that's everything I could have asked for. Thanks again for picking this up, and feel free to merge the PR, I already put my laptop away 🎉

@fredrik-bakke fredrik-bakke merged commit cd50e74 into UniMath:master Mar 11, 2024
4 checks passed
@fredrik-bakke fredrik-bakke deleted the bibliograph-pybtex branch March 11, 2024 23:02
fredrik-bakke added a commit to fredrik-bakke/agda-unimath that referenced this pull request Mar 14, 2024
Adds citation support using a biblatex file and
[pybtex](https://pybtex.org/), reactors most current citations to use
it, and adds a small guide to explain how to use it.

Resolves UniMath#957.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request tooling website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bibliography
3 participants