Bibliography in documentation (data in .json file, scripts checking consistency with DOI mentions in the codebase)

[pawelmagnu]

A couple of questions regarding this PR to @slayoo :

• Should the test to determine whether all dois referenced in code are in the JSON file be part of PySDM, or should we move it to a DevOps test?
• Should the bib table have more columns than the title, doi, and references to places in the code?
• Is the phrase "cross-reference" a good way to refer to places in code where each doi is mentioned?
• After this PR, the main .HTML file will have 8 subsections (intro, links, installation, dependencies etc.) Should we bring back the navigation for easier access and discovery of each section?

Also, before closing this PR we need to fill in the missing values(title, year, authors, etc.) in the JSON file, or remove these fields from JSON altogether.

[slayoo]

Thanks @pawelmagnu !

* Should the test to determine whether all dois referenced in code are in the JSON file be part of PySDM, or should we move it to a DevOps test?

Let me try to integrate it into the docs.py script, and then (in a separate PR), we can move out the script to some common location and is it from both PySDM and PyMPDATA

[slayoo]

* Should the bib table have more columns than the title, doi, and references to places in the code?

I've added a "label" field which is used for sorting

* Is the phrase "cross-reference" a good way to refer to places in code where each doi is mentioned?

yes! (I've also added a single-sentence paragraph explaining what is in the reference list)

* After this PR, the main .HTML file will have 8 subsections (intro, links, installation, dependencies etc.) Should we bring back the navigation for easier access and discovery of each section?

indeed, worth considering to bring it back

Also, before closing this PR we need to fill in the missing values(title, year, authors, etc.) in the JSON file, or remove these fields from JSON altogether.

done.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.22%. Comparing base (91278ac) to head (c1eef6a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1483   +/-   ##
=======================================
  Coverage   85.22%   85.22%           
=======================================
  Files         376      376           
  Lines        9266     9266           
=======================================
  Hits         7897     7897           
  Misses       1369     1369           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.