Skip to content

Feat/Fix: Centralize academic references in the examples#199

Open
almahova wants to merge 10 commits into
mainfrom
feat/bib-links
Open

Feat/Fix: Centralize academic references in the examples#199
almahova wants to merge 10 commits into
mainfrom
feat/bib-links

Conversation

@almahova

@almahova almahova commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Centralizes academic paper references and bibliography across all examples by moving from hardcoded text to a dynamically parsed, single .bib file.

Changes

  • All academic paper references are in a single .bib file.
  • Created a new file docs/references.py that parses the .bib file using bibtexparser and formats references into standard Marimo links (mo.md).
  • Removed all MATLAB references from the examples.
  • Added __init__.py to the docs/ directory to expose the new function as an importable package for the examples.
  • Added bibtexparser to pyproject.toml.

Testing

  • pytest passes locally (python -m pytest)
  • New tests added for new functionality
  • Coverage not decreased (pytest --cov=pyFDN)

Checklist

  • Pre-commit hooks pass (pre-commit run --all-files)
  • Docstrings updated for any changed public API
  • HISTORY.rst updated if this is a user-facing change

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.

1 participant