From d10ac9d16240ed41727d250f5e14d210d2d906f2 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Fri, 12 Jul 2024 09:20:49 +0800 Subject: [PATCH] docs: suppress warning from autosectionlabel to silence the warning from sphinx, as we have two "Dropwizard Metrics" sections in manual/core/metrics/index.md: ``` /home/kefu/dev/scylla-java-driver/docs/_source/manual/core/metrics/index.md:291: WARNING: duplicate label manual/core/metrics/index:dropwizard metrics, other instance in /home/kefu/dev/scyll a-java-driver/docs/_source/manual/core/metrics/index.md ``` and the warning breaks the "make test". so let's suppress the warning at this moment. Signed-off-by: Kefu Chai --- docs/source/conf.py | 4 ++-- manual/core/metrics/README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7769a0c6059..d10905eed13 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,7 @@ 'sphinx_sitemap', 'sphinx.ext.autosectionlabel', 'sphinx_scylladb_theme', - 'sphinx_multiversion', + # 'sphinx_multiversion', 'sphinx_scylladb_markdown' ] @@ -100,7 +100,7 @@ 'scylla-4.14.1.x', 'scylla-4.15.0.x', ] -suppress_warnings = ["ref.any", "myst.header","myst.xref_missing"] +suppress_warnings = ["ref.any", "myst.header","myst.xref_missing","autosectionlabel"] # -- Options for multiversion extension diff --git a/manual/core/metrics/README.md b/manual/core/metrics/README.md index 6f3a16983c4..d931ffd66dd 100644 --- a/manual/core/metrics/README.md +++ b/manual/core/metrics/README.md @@ -29,7 +29,7 @@ under the License. ----- The driver is able to report measurements of its internal behavior to a variety of metrics -libraries, and ships with bindings for three popular ones: [Dropwizard Metrics] , [Micrometer +libraries, and ships with bindings for three popular ones: [Dropwizard Metrics][Dropwizard Metrics Library] , [Micrometer Metrics] and [MicroProfile Metrics]. ### Selecting a Metrics Library @@ -360,9 +360,9 @@ reporter.start(); Dropwizard Metrics has built-in reporters for other output formats: JSON (via a servlet), stdout, CSV files, SLF4J logs and Graphite. Refer to their [manual][Dropwizard manual] for more details. -[Dropwizard Metrics]: https://metrics.dropwizard.io/4.1.2 +[Dropwizard Metrics Library]: https://metrics.dropwizard.io/4.1.2 [Dropwizard Manual]: https://metrics.dropwizard.io/4.1.2/getting-started.html [Micrometer Metrics]: https://micrometer.io/docs [Micrometer JMX]: https://micrometer.io/docs/registry/jmx [MicroProfile Metrics]: https://github.com/eclipse/microprofile-metrics -[reference configuration]: ../configuration/reference/ \ No newline at end of file +[reference configuration]: ../configuration/reference/