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

Enable bibtex references in the documentation #215

Merged
merged 2 commits into from
Jul 4, 2023
Merged

Conversation

drbenvincent
Copy link
Collaborator

  • This PR enables you to use bibtex references in the documentation.
  • Extension changes: This is done through sphinxcontrib.bibtex, but we also now use myst_nb (see https://myst-nb.readthedocs.io/en/latest/index.html) and no explicitly use nbsphinx or myst_parser.
  • That change to use myst_nb also allowed us to use simpler admonitions, so this was changed in all the relevant example notebooks.
  • Default behaviour is to collect all references (site wide) into a single reference section. But because the site is / will be heavy with example notebooks then it makes sense to keep references at the end of each notebook. This is the same style as the pymc-examples repo.
  • This will close Enable bibtex references in the docs #214.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@drbenvincent drbenvincent merged commit ac36ffc into main Jul 4, 2023
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.

Enable bibtex references in the docs
1 participant