Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create author list dynamically in docs #94

Merged
merged 4 commits into from
May 21, 2024

Conversation

endast
Copy link
Collaborator

@endast endast commented May 21, 2024

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..

@endast endast changed the title Create autorlist dynamically Create author list dynamically in docs May 21, 2024
@endast endast requested review from bfclarke and Marcel-Mueck May 21, 2024 10:22
@endast endast marked this pull request as ready for review May 21, 2024 10:22
Copy link
Collaborator

@Marcel-Mueck Marcel-Mueck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@endast endast merged commit aa5c87a into main May 21, 2024
13 checks passed
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.

2 participants