Skip to content

Commit

Permalink
docs: suppress warning from autosectionlabel
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
tchaikov committed Jul 12, 2024
1 parent db334b9 commit d10ac9d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
'sphinx_sitemap',
'sphinx.ext.autosectionlabel',
'sphinx_scylladb_theme',
'sphinx_multiversion',
# 'sphinx_multiversion',
'sphinx_scylladb_markdown'
]

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions manual/core/metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
[reference configuration]: ../configuration/reference/

0 comments on commit d10ac9d

Please sign in to comment.