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

Fix remaining warnings in the documentations #260

Merged
merged 8 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions docs/source/api-reference/adapters.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/source/api-reference/drivers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ can.md
pyserial.md
sdwire.md
ustreamer.md
yepkit.md
Copy link
Member

Choose a reason for hiding this comment

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

oops :D

```
2 changes: 1 addition & 1 deletion docs/source/api-reference/drivers/pyserial.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export:

## PySerialClient API
```{eval-rst}
.. autoclass:: "jumpstarter_driver_pyserial.client.PySerialClient
.. autoclass:: jumpstarter_driver_pyserial.client.PySerialClient
:members: pexpect, open, stream, open_stream, close
```

Expand Down
1 change: 0 additions & 1 deletion docs/source/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ This section provides details on the Jumpstarter core API and contrib drivers.

```{toctree}
drivers.md
adapters.md
drivers/index.md
adapters/index.md
```
4 changes: 3 additions & 1 deletion docs/source/cli-reference/jmp-exporter.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# jmp-exporter

```{eval-rst}
.. click:: jumpstarter.cli.exporter:exporter
.. click:: jumpstarter_cli_exporter:exporter
:prog: jmp-exporter
:nested: full
```
4 changes: 3 additions & 1 deletion docs/source/cli-reference/jmp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# jmp

```{eval-rst}
.. click:: jumpstarter.cli.client:client
.. click:: jumpstarter_cli_client:client
:prog: jmp
:nested: full
```
Expand Down
1 change: 0 additions & 1 deletion docs/source/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
getting-started.md
clients.md
exporters.md
configuration.md
run-tests.md
shell.md
```
4 changes: 2 additions & 2 deletions docs/source/introduction/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ automatically use any drivers that are registered without the need for an
exporter instance running in the background.

You can get started with a local client by following the
[Setup a Local Client](../getting-started/setup-local-client.md) guide.
[Setup a Local Client](../getting-started/setup-local-exporter.md) guide.

### Remote Clients

Expand All @@ -36,7 +36,7 @@ with the Jumpstarter Service.
```

You can get started with a remove client by following the
[Setup a Remote Client](../getting-started/setup-remote-client.md) guide.
[Setup a Remote Client](../getting-started/setup-exporter-client.md) guide.

We will discuss how remote clients connect to exporters in the next section
on the [Jumpstarter Service](./service.md).
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ jumpstarter-imagehash = { workspace = true }
jumpstarter-kubernetes = { workspace = true }
jumpstarter-protocol = { workspace = true }
jumpstarter-testing = { workspace = true }
sphinx-click = { git = "https://github.com/NickCao/sphinx-click" }

[dependency-groups]
docs = [
Expand All @@ -36,7 +37,12 @@ docs = [
"sphinx-click>=6.0.0",
"sphinx-substitution-extensions>=2024.10.17",
]
dev = ["ruff==0.9.2", "typos>=1.23.6", "pre-commit>=3.8.0", "esbonio>=0.16.5"]
dev = [
"ruff==0.9.2",
"typos>=1.23.6",
"pre-commit>=3.8.0",
"esbonio>=0.16.5",
]

[tool.ruff]
exclude = ["packages/jumpstarter-protocol"]
Expand Down
141 changes: 70 additions & 71 deletions uv.lock

Large diffs are not rendered by default.

Loading