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.

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

Remove myst.xref_missing suppression in Sphinx config #1529

Merged
merged 2 commits into from
Nov 6, 2023
+5 −5
Merged

Remove myst.xref_missing suppression in Sphinx config #1529

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
2eddb0b
Remove myst.xref_missing suppression in Sphinx config
rzetelskik Nov 6, 2023
948cd6c
Fix invalid references in documentation
rzetelskik Nov 6, 2023
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/source/_ext/scylladb_markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ def setup(self):
try:
self.app.setup_extension('myst_parser')
self.app.config.myst_enable_extensions = ["colon_fence"]
self.app.config.myst_heading_anchors = 6

# TODO: https://github.com/scylladb/scylla-operator/issues/1421
# TODO: https://github.com/scylladb/scylla-operator/issues/1422
self.app.config.suppress_warnings = ["myst.xref_missing", "myst.header"]
self.app.config.suppress_warnings = ["myst.header"]

except ImportError:
raise RuntimeError("myst-parser is not installed")
Expand Down
2 changes: 1 addition & 1 deletion docs/source/eks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ cd examples/eks
./eks.sh -z "$EKS_ZONES" -r "$EKS_REGION"
```

After you deploy, see how you can [benchmark your cluster with cassandra-stress](#benchmark-with-cassandra-stress).
After you deploy, see how you can [benchmark your cluster with cassandra-stress](generic.md#benchmark-with-cassandra-stress).

## Walkthrough

Expand Down
2 changes: 1 addition & 1 deletion docs/source/gke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ cd examples/gke
Make sure to pass a ZONE (ex.: us-west1-b) and not a REGION (ex.: us-west1) or it will deploy nodes in each ZONE available in the region.
:::

After you deploy, see how you can [benchmark your cluster with cassandra-stress](#benchmark-with-cassandra-stress).
After you deploy, see how you can [benchmark your cluster with cassandra-stress](generic.md#benchmark-with-cassandra-stress).

## Walkthrough

Expand Down
2 changes: 1 addition & 1 deletion docs/source/multidc/multidc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,4 +598,4 @@ kubectl --context="${CONTEXT_DC2}" patch scyllacluster/scylla-cluster --type mer
## ScyllaDBMonitoring

To monitor your cluster, deploy ScyllaDBMonitoring in every datacenter independently.
To deploy ScyllaDB Monitoring, follow the steps described in [Deploy managed monitoring](../monitoring#deploy-managed-monitoring) in ScyllaDB Operator documentation.
To deploy ScyllaDB Monitoring, follow the steps described in [Deploy managed monitoring](../monitoring.md#deploy-managed-monitoring) in ScyllaDB Operator documentation.