From 57ed74ff624b7802b735e1ce8707c3a75b0dd3e5 Mon Sep 17 00:00:00 2001 From: Becky Sweger Date: Tue, 22 Oct 2024 16:34:51 -0400 Subject: [PATCH] Add intersphinx mapping to nextstrain --- docs/conf.py | 3 ++- src/cladetime/cladetime.py | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e969f1f..35eb4fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,9 +39,10 @@ github_repository = "cladetime" intersphinx_mapping = { + "nextstrain": ("https://docs.nextstrain.org/projects/nextstrain-dot-org/en/latest/index.html", None), + "polars": ("https://docs.pola.rs/api/python/stable", None), "python": ("https://docs.python.org/3/", None), "sphinx": ("https://www.sphinx-doc.org/en/master/", None), - "polars": ("https://docs.pola.rs/api/python/stable", None), } intersphinx_disabled_domains = ["std"] diff --git a/src/cladetime/cladetime.py b/src/cladetime/cladetime.py index 8cf049c..c0c8cac 100644 --- a/src/cladetime/cladetime.py +++ b/src/cladetime/cladetime.py @@ -25,8 +25,9 @@ class CladeTime: Parameters ---------- sequence_as_of : datetime.datetime | str | None - Sets the versions of Nextstrain SARS-CoV-2 genome sequence - and sequence metadata files that will be used by + Sets the versions of Nextstrain SARS-CoV-2 + :external+nextstrain:ref:`ingest datasets ` + (genome sequence and sequence metadata) files that will be used by CladeTime properties and methods. Can be a datetime object or a string in YYYY-MM-DD format, both of which will be treated as UTC. The default value is the current time.