Create author list dynamically in docs #94
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Then try adding a new author to the citations.cff example:
Build the docs again
make html && open _build/html/index.html
The docs should now contain the new author:
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..