Skip to content

Add citation guidance to docs#888

Draft
skyswordw wants to merge 1 commit into
nteract:mainfrom
skyswordw:add-citation-docs
Draft

Add citation guidance to docs#888
skyswordw wants to merge 1 commit into
nteract:mainfrom
skyswordw:add-citation-docs

Conversation

@skyswordw

Copy link
Copy Markdown

Summary

  • add a short citation section to the documentation home page
  • give academic users a factual software citation template with the project URL and version placeholder

Closes #881.

Validation

  • .venv/bin/sphinx-build -d .tox/docs_doctree docs .tox/docs_out --color -W -bhtml
  • git diff --check

I also tried .venv/bin/tox -e docs, but tox skipped locally because this repository maps the docs environment to python3.13, which is not installed on this machine.

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.

Instructions on how to cite papermill in an academic paper.

1 participant