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

docs: update rtd to use sphinxcontrib-bibtex v2.0.0 and later #1019

Merged
merged 1 commit into from
Mar 1, 2022

Conversation

andrew-platt
Copy link
Collaborator

This PR is ready to merge.

Summary
I had locked the sphinxcontrib-bibtex version to < 2.0.0 when I ran into issues with multiple bibliographies that we use (one per module). This was increasingly becoming a problem as python 3.8 and later would like to use a newer version.

Solution
The conf.py was updated to include a bibtex_bibfiles variable. However, the new version of sphinxcontrib-bibtex is more thorough in checking for repeated bibtex entries, and complained about a few duplicated entries (checked across all bib files). This required hardcoding of the keyprefix values into each modules .bib file instead of using sphinx to insert them. The rendering is therefore identical to the previous behavior, but will now compile correctly with the newer package.

See https://ap-openfast.readthedocs.io/en/f-docs-bibtex2.0.0/source/user/fast.farm/zrefs.html (duplicated entries first appeared in the fast.farm docs).

- new entry in conf.py for the bibtex config
- had to remove the keyprefix from references
@andrew-platt
Copy link
Collaborator Author

@bjonkman, this should fix the python version issue you ran into with the documentation builds.

@bjonkman
Copy link
Contributor

bjonkman commented Mar 1, 2022

Thanks, @andrew-platt!

@andrew-platt andrew-platt merged commit 2044291 into OpenFAST:dev Mar 1, 2022
@andrew-platt andrew-platt deleted the f/docs-Bibtex2.0.0 branch March 2, 2022 17:22
@rafmudaf rafmudaf mentioned this pull request Mar 2, 2022
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants