-
Notifications
You must be signed in to change notification settings - Fork 5
docs: literature references #45
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
slayoo
opened on Nov 28, 2024
Issue body actions
- check presence of a bibliography JSON file:
- DOI labels as main dictionary key
- "usages" key pointing to a list of project files in which the ref is mentioned
- "label" field like "Magnuszewski et al. 2025"
- "title", "year", "authors" fields - as in bib files
- "note" field explaining how and why the ref is used
- html/jinja file with JS code downloading the JSON and rendering it (as in https://stackoverflow.com/questions/29538002/how-to-load-json-file-to-a-html-table-using-javascript)
- new devops tests featuring:
- loading the JSON bib file
- scanning all-but-bib.json files in the repo for HTML or Markdown DOI links incl. generation of "usages" (with files and labels)
- comparing is the scan results are consistent with DOI keys, labels and "usages" in the bib JSON file (as in https://github.com/open-atmos/PySDM/blob/main/tests/examples_tests/test_tests_completeness.py)
- for future:
- matching DOIs with titles, authors and other metadata from http://dimensions.ai/
- dimensions.ai badges in the HTML refs page?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Fields
Give feedbackNo fields configured for issues without a type.