lsst-sqre / documenteer

Sphinx extensions, configurations, and tooling for Rubin Observatory documentation projects
https://documenteer.lsst.io
MIT License
5 stars 3 forks source link

DM-41214: Add a GitHub-based bibtex file cache extension #191

Closed jonathansick closed 9 months ago

jonathansick commented 9 months ago

The new extension, documenteer.ext.githubbibcache, can fetch and locally cache bibtex files from one or more public GitHub repositories. These bibfiles are automatically added to sphinxcontrib-bibtex's bibtex_files configuration.

Rubin technotes are now configured to automatically cache all bibfiles from the https://github.com/lsst/lsst-texmf repository. The sphinxcontrib-bibtex extension is available to technotes as well.

Because of a bug found in docutils <0.20 where it adds an extraneous and unclosed <div> element to the page when the bibliography directive from sphinxcontrib-bibtex is used, we're now requiring Sphinx>=7 for Documenteer. This in turn enables us to upgrade to docutils 0.20 and later.