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

Add citation to docs #167

Merged
merged 3 commits into from
Mar 12, 2024
Merged

Add citation to docs #167

merged 3 commits into from
Mar 12, 2024

Conversation

toloudis
Copy link
Contributor

@toloudis toloudis commented Mar 4, 2024

Add citation info to the docs. Also automate the insertion of year and agave version number!

Expected time to review: 5 min

@toloudis toloudis requested a review from a team as a code owner March 4, 2024 22:28
@toloudis toloudis requested review from meganrm and rugeli and removed request for a team March 4, 2024 22:28
docs/agave.rst Outdated

@software{agave,
author = {Toloudis, Daniel and AGAVE Contributors},
title = {AGAVE: Advanced GPU Accelerated Volume Explorer}
Copy link

@rugeli rugeli Mar 5, 2024

Choose a reason for hiding this comment

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

Nit: add a comma here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed! thank you!!


.. |year| date:: %Y

Daniel Toloudis, AGAVE Contributors (|year|). AGAVE: Advanced GPU Accelerated Volume Explorer (Version |release|) [Computer software]. Allen Institute for Cell Science. https://github.com/allen-cell-animated/agave
Copy link

Choose a reason for hiding this comment

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

Do we manually update the release placeholder with each new version release?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes the release tag here picks up a version that is auto-incremented when I do releases.

Base automatically changed from feature/formlayouts to main March 5, 2024 01:01
Copy link

@rugeli rugeli left a comment

Choose a reason for hiding this comment

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

LGTM!

"}<br/>"
"&nbsp;&nbsp;organization = {Allen Institute for Cell Science}<br/>"
"},<br/>"
"&nbsp;&nbsp;organization = {Allen Institute for Cell Science},<br/>"
"&nbsp;&nbsp;note = {Computer Software}<br/>"
Copy link

Choose a reason for hiding this comment

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

do you need a comma after Software} here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nope! note is the last one in the list

@toloudis toloudis merged commit 23592c4 into main Mar 12, 2024
7 checks passed
@toloudis toloudis deleted the feature/docs-year-citation branch March 12, 2024 15:55
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.

3 participants