Skip to content

Fix docs #40

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.

Sign up for GitHub

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

Merged
marktsuchida merged 2 commits into from
Jan 6, 2026
Merged

Fix docs #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e012b13
Fix broken URL in docs
marktsuchida Jan 6, 2026
42543d4
Fix cross-references in docs
marktsuchida Jan 6, 2026
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
4 changes: 2 additions & 2 deletions docs/cachedir.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ variable [`CJDK_CACHE_DIR`](environ-cjdk-cache-dir).

You can safely delete the cache directory at any time, provided that **cjdk**
and the JDKs installed by it are not in use. You can use the
[`cjdk clear-cache`](cli.md#clear-cache) command or the
[`cjdk.clear_cache()`](api.md#cjdk.clear_cache) function to do this.
[`cjdk clear-cache`](cli-clear-cache) command or the
[`cjdk.clear_cache()`](cjdk.clear_cache) function to do this.
2 changes: 2 additions & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ shown was on macOS.)

## Managing the cache

(cli-clear-cache)=

### `clear-cache`

```{command-output} cjdk clear-cache --help
Expand Down
4 changes: 2 additions & 2 deletions docs/example-run-jgo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ from contextlib import contextmanager

```{code-cell} ipython3
# From https://maven.apache.org/download.html
maven_url = "tgz+https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.tar.gz"
maven_sha512 = "706f01b20dec0305a822ab614d51f32b07ee11d0218175e55450242e49d2156386483b506b3a4e8a03ac8611bae96395fd5eec15f50d3013d5deed6d1ee18224"
maven_url = "tgz+https://dlcdn.apache.org/maven/maven-3/3.9.12/binaries/apache-maven-3.9.12-bin.tar.gz"
maven_sha512 = "0a1be79f02466533fc1a80abbef8796e4f737c46c6574ede5658b110899942a94db634477dfd3745501c80aef9aac0d4f841d38574373f7e2d24cce89d694f70"
```

```{code-cell} ipython3
Expand Down