From 97daf90dd3d6d9f8344ac1a99f44d64324d0075b Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 11 Jul 2024 17:34:54 -0400 Subject: [PATCH] adds kramdown to dev dependencies Yard's default use of the rdoc markdown provider was choking on links containing codeblocks, for example: [`ENV`](link/to/somewhere). These style links are pretty popular in the text details provided with semconv attributes. Let's switch to kramdown which is a markdown parser and renderer that: * can handle inline code blocks inside a link anchor * is pure Ruby (no C extensions) so works with JRuby --- semantic_conventions/.yardopts | 1 + semantic_conventions/opentelemetry-semantic_conventions.gemspec | 1 + 2 files changed, 2 insertions(+) diff --git a/semantic_conventions/.yardopts b/semantic_conventions/.yardopts index fd17675afe..9f334b2d10 100644 --- a/semantic_conventions/.yardopts +++ b/semantic_conventions/.yardopts @@ -1,6 +1,7 @@ --no-private --title=OpenTelemetry Semantic Conventions --markup=markdown +--markup-provider=kramdown --main=README.md ./lib/opentelemetry/**/*.rb - diff --git a/semantic_conventions/opentelemetry-semantic_conventions.gemspec b/semantic_conventions/opentelemetry-semantic_conventions.gemspec index e09b108c86..1d642e75f8 100644 --- a/semantic_conventions/opentelemetry-semantic_conventions.gemspec +++ b/semantic_conventions/opentelemetry-semantic_conventions.gemspec @@ -30,6 +30,7 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'bundler', '>= 1.17' spec.add_development_dependency 'minitest', '~> 5.0' spec.add_development_dependency 'rake', '~> 12.0' + spec.add_development_dependency 'kramdown', '~> 2.3' spec.add_development_dependency 'rubocop', '~> 1.3' spec.add_development_dependency 'simplecov', '~> 0.17' spec.add_development_dependency 'yard', '~> 0.9'