diff --git a/docs/assets/404.html b/docs/assets/404.html new file mode 100644 index 0000000..1d2e863 --- /dev/null +++ b/docs/assets/404.html @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/assets/images/watz-py-0.0.1.zip b/docs/assets/images/watz-py-0.0.1.zip deleted file mode 100644 index e1397a1..0000000 Binary files a/docs/assets/images/watz-py-0.0.1.zip and /dev/null differ diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..60ad248 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,6 @@ +{% extends "base.html" %} {% block outdated %} You're not viewing the latest +version. + + Click here to go to latest. + +{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 0bc5b0e..a935b80 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ extra_css: theme: name: "material" + custom_dir: docs/overrides features: - navigation.instant - navigation.instant.progress diff --git a/watz.code-workspace b/watz.code-workspace index 4006516..ef4c516 100755 --- a/watz.code-workspace +++ b/watz.code-workspace @@ -47,6 +47,7 @@ "files.exclude": { "**/.venv/**": true, "**/venv/**": true, + "**/.nox/**": true, "**/coverage": true, "**/htmlcov": true, "**/__pycache__": true, @@ -59,6 +60,7 @@ "files.watcherExclude": { "**/.venv/**": true, "**/venv/**": true, + "**/.nox/**": true, "**/coverage": true, "**/htmlcov": true, "**/__pycache__": true, diff --git a/watz/client.py b/watz/client.py index aa82e86..6ec069f 100644 --- a/watz/client.py +++ b/watz/client.py @@ -73,7 +73,7 @@ def trace_list(self, nids: tp.Iterable[str]) -> RespTraceList: """Retrieves the trace metadata for the requested nodes. Args: - nids (tp.Iterable[str]): The node ids to retrieve trace metadata for. + nids (list[str]): The node ids to retrieve trace metadata for. Returns: RespTraceList @@ -89,7 +89,7 @@ def trace_data(self, traces: tp.Mapping[str, tp.Iterable[str]]) -> RespTraceData """Retrieves the trace data for the request traces. Args: - traces (tp.Mapping[str, tp.Iterable[str]]): A dict of node ids to a list of trace identifiers for each respective node. + traces (dict[str, list[str]]): A dict of node ids to a list of trace identifiers for each respective node. Returns: RespTraceData @@ -109,7 +109,7 @@ def create_nodes( """Creates new nodes. Args: - nodes (tp.Iterable[tp.Union[CreateActivityNode, CreateUserNode]]): The nodes to create. + nodes (list[tp.Union[CreateActivityNode, CreateUserNode]]): The nodes to create. Returns: RespCreateNodes @@ -127,7 +127,7 @@ def create_traces(self, traces: tp.Mapping[str, tp.Iterable[CreateTrace]]) -> Re """Creates new traces. Args: - traces (tp.Mapping[str, tp.Iterable[CreateTrace]]): A dict of node ids to a list of traces to create for each respective node. + traces (dict[str, tp.Iterable[CreateTrace]]): A dict of node ids to a list of traces to create for each respective node. Returns: RespCreateTraces