Skip to content

Commit

Permalink
Specifies sphinxcontrib-bibtex version for the docs (#270)
Browse files Browse the repository at this point in the history
This MR specifies the sphinxcontrib-bibtex==2.5.0 to prevent hanging upon
building docs with python3.10. When the version is greater than this, it causes
pip to hang on requirements.txt installation such that building docs is
impossible.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
  • Loading branch information
hhansen-bdai authored Dec 4, 2023
1 parent 0c97da0 commit 4875c51
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# for building the docs
sphinx-book-theme==1.0.1
myst-parser
sphinxcontrib-bibtex
sphinxcontrib-bibtex==2.5.0
autodocsumm
sphinx-copybutton
sphinx_design
Expand Down

0 comments on commit 4875c51

Please sign in to comment.