PMBio / deeprvat

Other
15 stars 1 forks source link

Create author list dynamically in docs #94

Closed endast closed 1 month ago

endast commented 1 month ago

What

This PR updates the doc build process so that we add the authors to the doc automatically from the citations.cff file, so we don't have to update them i 3 separate places.

Testing

To test this pr you can first build the docs and look at the author list in the docs:

make html && open _build/html/index.html

Screenshot 2024-05-21 at 12 18 39

Then try adding a new author to the citations.cff example:

...
  - given-names: Oliver
    family-names: Stegle
    orcid: 'https://orcid.org/0000-0002-8818-7193'
  - given-names: John
    family-names: Doe
    orcid: 'https://orcid.org/0000-0002-8818-7193'

Build the docs again make html && open _build/html/index.html

The docs should now contain the new author:

Screenshot 2024-05-21 at 12 15 31

Note: This will add new authors to the docs that were not present in the docs (but exist in the citations.cff).

Before: © Copyright 2024, Clarke, B., Holtkamp, E., Öztürk, H., Mück, M., Wahlberg, M., Meyer, K., Brechtmann, F., Hölzlwimmer, F. R., Gagneur, J., & Stegle, O

After:

© Copyright 2024, Clarke, B., Holtkamp, E., Öztürk, H., Mück, M., Wahlberg, M., Meyer, K., Munzlinger, F., Brechtmann, F., Hölzlwimmer, F., Gagneur, J., Stegle, O..