Skip to content

Commit d10ac9d

Browse files
committed
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 <kefu.chai@scylladb.com>
1 parent db334b9 commit d10ac9d

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
'sphinx_sitemap',
4343
'sphinx.ext.autosectionlabel',
4444
'sphinx_scylladb_theme',
45-
'sphinx_multiversion',
45+
# 'sphinx_multiversion',
4646
'sphinx_scylladb_markdown'
4747
]
4848

@@ -100,7 +100,7 @@
100100
'scylla-4.14.1.x',
101101
'scylla-4.15.0.x',
102102
]
103-
suppress_warnings = ["ref.any", "myst.header","myst.xref_missing"]
103+
suppress_warnings = ["ref.any", "myst.header","myst.xref_missing","autosectionlabel"]
104104

105105
# -- Options for multiversion extension
106106

manual/core/metrics/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ under the License.
2929
-----
3030

3131
The driver is able to report measurements of its internal behavior to a variety of metrics
32-
libraries, and ships with bindings for three popular ones: [Dropwizard Metrics] , [Micrometer
32+
libraries, and ships with bindings for three popular ones: [Dropwizard Metrics][Dropwizard Metrics Library] , [Micrometer
3333
Metrics] and [MicroProfile Metrics].
3434

3535
### Selecting a Metrics Library
@@ -360,9 +360,9 @@ reporter.start();
360360
Dropwizard Metrics has built-in reporters for other output formats: JSON (via a servlet), stdout,
361361
CSV files, SLF4J logs and Graphite. Refer to their [manual][Dropwizard manual] for more details.
362362

363-
[Dropwizard Metrics]: https://metrics.dropwizard.io/4.1.2
363+
[Dropwizard Metrics Library]: https://metrics.dropwizard.io/4.1.2
364364
[Dropwizard Manual]: https://metrics.dropwizard.io/4.1.2/getting-started.html
365365
[Micrometer Metrics]: https://micrometer.io/docs
366366
[Micrometer JMX]: https://micrometer.io/docs/registry/jmx
367367
[MicroProfile Metrics]: https://github.com/eclipse/microprofile-metrics
368-
[reference configuration]: ../configuration/reference/
368+
[reference configuration]: ../configuration/reference/

0 commit comments

Comments
 (0)