Skip to content

Commit

Permalink
Add intersphinx mapping to nextstrain
Browse files Browse the repository at this point in the history
  • Loading branch information
bsweger committed Oct 22, 2024
1 parent dd824e5 commit 57ed74f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]

Expand Down
5 changes: 3 additions & 2 deletions src/cladetime/cladetime.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ingest dataset>`
(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.
Expand Down

0 comments on commit 57ed74f

Please sign in to comment.