Skip to content

Commit

Permalink
adds kramdown to dev dependencies
Browse files Browse the repository at this point in the history
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
  • Loading branch information
robbkidd committed Jul 19, 2024
1 parent a641734 commit 0446676
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions semantic_conventions/.yardopts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
--no-private
--title=OpenTelemetry Semantic Conventions
--markup=markdown
--markup-provider=kramdown
--main=README.md
./lib/opentelemetry/**/*.rb
-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
spec.add_dependency 'opentelemetry-api', '~> 1.0'

spec.add_development_dependency 'bundler', '>= 1.17'
spec.add_development_dependency 'kramdown', '~> 2.3'
spec.add_development_dependency 'minitest', '~> 5.0'
spec.add_development_dependency 'rake', '~> 12.0'
spec.add_development_dependency 'rubocop', '~> 1.3'
Expand Down

0 comments on commit 0446676

Please sign in to comment.