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

Sphinx Bibtext Fix #1559

Merged
merged 3 commits into from
Dec 16, 2020
Merged

Sphinx Bibtext Fix #1559

merged 3 commits into from
Dec 16, 2020

Conversation

blisc
Copy link
Collaborator

@blisc blisc commented Dec 14, 2020

No description provided.

Signed-off-by: Jason <jasoli@nvidia.com>
Comment on lines 3 to +4
make html
make html
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Kinda of a "dumb" fix. Version 2.0.0 of sphinxcontrib-bibtex requires users to either build sphinx twice or add "bibtext.json" to the version control.
Note that this fix will not fix the RTD build, which is equally as problematic.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Alternatively, we can just pin sphinxcontrib-bibtex==1.0.0. @tkornuta-nvidia thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

@blisc those changes are good for local build, but as you pointed out won't solve RTD build - so be effectively loose access to the latest documentation. So how about pinning to sphinxcontrib-bibtex<2.0.0 as suggested:
mcmtroffaes/sphinxcontrib-bibtex#214 (comment)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I am ok with either solution:

  1. Pin sphinxcontrib-bibtex<2.0.0
  2. Add bibtext.json to github
    @okuchaiev, thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

@blisc up to you

@blisc blisc merged commit b7211be into NVIDIA:main Dec 16, 2020
@blisc blisc deleted the docs_fix branch December 16, 2020 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants