ProjectPythia / ProjectPythia/pythia-foundations
References section for Foundations
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 72
- Forks
- 60
- Avg merge
- 17h 36m
- Merged PRs (30d)
- 2
Description
Currently we have references hyperlinked at the end of each notebook. Jupyterbook supports citations and bibliographies at the book level. Instead of using DOI links to published works directly in the notebooks, we could instead drop in cite commands like
{cite:t}`perez2011python`
and maintain reference metadata in a separate bibtex file.
(This is what I do for my Climate Laboratory Book)
Jupyterbook would then construct a hyperlinked bibliography page which we could add to the Appendix of the book.
As we discussed at today's EWG meeting, having a proper References section in the Foundations book would serve as a useful example of what it might look like for individual Cookbooks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing DOI links at the ends of the notebooks and the JupyterBook citations and bibliographies documentation linked in the issue. Replace the direct references with citation commands, maintain the metadata in a separate BibTeX file, and add the generated hyperlinked bibliography to the book appendix.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100