Module: Jazzy::DocBuilder
- Defined in:
- lib/jazzy/doc_builder.rb,
lib/jazzy/docset_builder.rb
Overview
This module handles HTML generation, file writing, asset copying, and generally building docs given sourcekitten output
Defined Under Namespace
Classes: DocsetBuilder
Class Method Summary collapse
-
.build(options) ⇒ Object
Build documentation from the given options.
-
.build_docs(output_dir, source_module) ⇒ Object
Build & write HTML docs to disk from structured docs array.
-
.build_docs_for_sourcekitten_output(sourcekitten_output, options) ⇒ Object
Build docs given sourcekitten output.
- .build_site(docs, coverage, options) ⇒ Object
- .children_for_doc(doc) ⇒ Object
-
.color_for_coverage(coverage) ⇒ Object
Returns the appropriate color for the provided percentage, used for generating a badge on shields.io.
- .copy_extension(name, destination) ⇒ Object
- .copy_extensions(source_module, destination) ⇒ Object
- .copy_theme_assets(destination) ⇒ Object
-
.doc_structure_for_docs(docs) ⇒ Array
Generate doc structure to be used in sidebar navigation.
-
.document(source_module, doc_model, path_to_root) ⇒ Object
rubocop:disable Metrics/MethodLength Build Mustache document from single parsed decl.
-
.document_markdown(source_module, doc_model, path_to_root) ⇒ Object
Build Mustache document from a markdown source file.
- .each_doc(output_dir, docs, &block) ⇒ Object
-
.generate_badge(coverage, options) ⇒ Object
Generates an SVG similar to those from shields.io displaying the documentation percentage.
-
.make_breadcrumbs(doc_model) ⇒ Object
Breadcrumbs for a page - doesn’t include the top ‘readme’ crumb.
-
.make_task(mark, uid, items, doc_model) ⇒ Object
rubocop:enable Metrics/MethodLength.
-
.new_document(source_module, doc_model) ⇒ Object
Build Mustache document - common fields between page types.
-
.prepare_output_dir(output_dir, clean) ⇒ Object
mkdir -p output directory and clean if option is set.
- .relative_path_if_inside(path, base_path) ⇒ Object
- .render(doc_model, markdown) ⇒ Object
- .render_inline(doc_model, markdown) ⇒ Object
-
.render_item(item, source_module) ⇒ Object
Build mustache item for a top-level doc rubocop:disable Metrics/MethodLength.
-
.render_tasks(source_module, children) ⇒ Object
Render tasks for Mustache document.
- .undocumented_warnings(decls) ⇒ Object
- .write_lint_report(undocumented, options) ⇒ Object
Class Method Details
.build(options) ⇒ Object
Build documentation from the given options
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/jazzy/doc_builder.rb', line 70 def self.build() module_jsons = .module_configs.map do |module_config| if module_config.podspec_configured # Config#validate guarantees not multi-module here pod_documenter = PodspecDocumenter.new(.podspec) pod_documenter.sourcekitten_output() elsif !module_config.sourcekitten_sourcefile.empty? "[#{module_config.sourcekitten_sourcefile.map(&:read).join(',')}]" elsif module_config.swift_build_tool == :symbolgraph SymbolGraph.build(module_config) else Dir.chdir(module_config.source_directory) do arguments = SourceKitten.(module_config) SourceKitten.run_sourcekitten(arguments) end end end build_docs_for_sourcekitten_output(module_jsons, ) end |
.build_docs(output_dir, source_module) ⇒ Object
Build & write HTML docs to disk from structured docs array
94 95 96 97 98 99 100 101 102 103 |
# File 'lib/jazzy/doc_builder.rb', line 94 def self.build_docs(output_dir, source_module) each_doc(output_dir, source_module.docs) do |doc, path| prepare_output_dir(path.parent, false) depth = path.relative_path_from(output_dir).each_filename.count - 1 path_to_root = '../' * depth path.open('w') do |file| file.write(document(source_module, doc, path_to_root)) end end end |
.build_docs_for_sourcekitten_output(sourcekitten_output, options) ⇒ Object
Build docs given sourcekitten output
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/jazzy/doc_builder.rb', line 156 def self.build_docs_for_sourcekitten_output(sourcekitten_output, ) (docs, stats) = SourceKitten.parse( sourcekitten_output, , DocumentationGenerator.source_docs, ) prepare_output_dir(.output, .clean) stats.report unless .skip_documentation build_site(docs, stats.doc_coverage, ) end write_lint_report(stats.undocumented_decls, ) end |
.build_site(docs, coverage, options) ⇒ Object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/jazzy/doc_builder.rb', line 120 def self.build_site(docs, coverage, ) warn 'building site' structure = doc_structure_for_docs(docs) docs << SourceDocument.make_index(.readme_path) output_dir = .output docset_builder = DocsetBuilder.new(output_dir) source_module = SourceModule.new(docs, structure, coverage, docset_builder) build_docs(output_dir, source_module) unless .disable_search warn 'building search index' SearchBuilder.build(source_module, output_dir) end copy_extensions(source_module, output_dir) copy_theme_assets(output_dir) docset_builder.build!(source_module.all_declarations) generate_badge(source_module.doc_coverage, ) friendly_path = relative_path_if_inside(output_dir, Pathname.pwd) puts "jam out ♪♫ to your fresh new docs in `#{friendly_path}`" source_module end |
.children_for_doc(doc) ⇒ Object
54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/jazzy/doc_builder.rb', line 54 def self.children_for_doc(doc) doc.children .sort_by { |c| [c.nav_order, c.name, c.usr || ''] } .flat_map do |child| # FIXME: include arbitrarily nested extensible types [{ name: child.name, url: child.url }] + Array(child.children.select do |sub_child| sub_child.type.swift_extensible? || sub_child.type.extension? end).map do |sub_child| { name: "– #{sub_child.name}", url: sub_child.url } end end end |
.color_for_coverage(coverage) ⇒ Object
Returns the appropriate color for the provided percentage, used for generating a badge on shields.io
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/jazzy/doc_builder.rb', line 286 def self.color_for_coverage(coverage) if coverage < 10 'e05d44' # red elsif coverage < 30 'fe7d37' # orange elsif coverage < 60 'dfb317' # yellow elsif coverage < 85 'a4a61d' # yellowgreen elsif coverage < 90 '97CA00' # green else '4c1' # brightgreen end end |
.copy_extension(name, destination) ⇒ Object
230 231 232 233 |
# File 'lib/jazzy/doc_builder.rb', line 230 def self.copy_extension(name, destination) ext_directory = Pathname(__dir__) / 'extensions' / name FileUtils.cp_r(ext_directory.children, destination) end |
.copy_extensions(source_module, destination) ⇒ Object
223 224 225 226 227 228 |
# File 'lib/jazzy/doc_builder.rb', line 223 def self.copy_extensions(source_module, destination) if source_host = source_module.host&.extension copy_extension(source_host, destination) end copy_extension('katex', destination) if Markdown.has_math end |
.copy_theme_assets(destination) ⇒ Object
212 213 214 215 216 217 218 219 220 221 |
# File 'lib/jazzy/doc_builder.rb', line 212 def self.copy_theme_assets(destination) assets_directory = Config.instance.theme_directory + 'assets' FileUtils.cp_r(assets_directory.children, destination) Pathname.glob(destination + 'css/**/*.scss').each do |scss| css = SassC::Engine.new(scss.read).render css_filename = scss.sub(/\.scss$/, '') css_filename.open('w') { |f| f.write(css) } FileUtils.rm scss end end |
.doc_structure_for_docs(docs) ⇒ Array
Generate doc structure to be used in sidebar navigation
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/jazzy/doc_builder.rb', line 34 def self.doc_structure_for_docs(docs) docs .map do |doc| children = children_for_doc(doc) { section: doc.name, url: doc.url, children: children, } end .select do |structure| if Config.instance.hide_unlisted_documentation unlisted_prefix = Config.instance.custom_categories_unlisted_prefix structure[:section] != "#{unlisted_prefix}Guides" else true end end end |
.document(source_module, doc_model, path_to_root) ⇒ Object
rubocop:disable Metrics/MethodLength Build Mustache document from single parsed decl
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/jazzy/doc_builder.rb', line 423 def self.document(source_module, doc_model, path_to_root) if doc_model.type.markdown? return document_markdown(source_module, doc_model, path_to_root) end overview = (doc_model.abstract || '') + (doc_model.discussion || '') alternative_abstract = doc_model.alternative_abstract if alternative_abstract overview = render(doc_model, alternative_abstract) + overview end doc = new_document(source_module, doc_model) doc[:name] = doc_model.name doc[:kind] = doc_model.type.name doc[:dash_type] = doc_model.type.dash_type doc[:declaration] = doc_model.display_declaration doc[:language] = doc_model.display_language doc[:other_language_declaration] = doc_model.display_other_language_declaration doc[:overview] = overview doc[:parameters] = doc_model.parameters doc[:return] = doc_model.return doc[:tasks] = render_tasks(source_module, doc_model.children) doc[:path_to_root] = path_to_root doc[:deprecation_message] = doc_model. doc[:unavailable_message] = doc_model. doc[:usage_discouraged] = doc_model.usage_discouraged? doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root) end |
.document_markdown(source_module, doc_model, path_to_root) ⇒ Object
Build Mustache document from a markdown source file
273 274 275 276 277 278 279 280 281 |
# File 'lib/jazzy/doc_builder.rb', line 273 def self.document_markdown(source_module, doc_model, path_to_root) doc = new_document(source_module, doc_model) name = doc_model.readme? ? source_module.readme_title : doc_model.name doc[:name] = name doc[:overview] = render(doc_model, doc_model.content(source_module)) doc[:path_to_root] = path_to_root doc[:hide_name] = true doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root) end |
.each_doc(output_dir, docs, &block) ⇒ Object
105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/jazzy/doc_builder.rb', line 105 def self.each_doc(output_dir, docs, &block) docs.each do |doc| next unless doc.render_as_page? # Filepath is relative to documentation root: path = output_dir + doc.filepath block.call(doc, path) each_doc( output_dir, doc.children, &block ) end end |
.generate_badge(coverage, options) ⇒ Object
Generates an SVG similar to those from shields.io displaying the documentation percentage
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/jazzy/doc_builder.rb', line 308 def self.generate_badge(coverage, ) return if .hide_documentation_coverage coverage_length = coverage.to_s.size.succ percent_string_length = coverage_length * 80 + 10 percent_string_offset = coverage_length * 40 + 975 width = coverage_length * 8 + 104 svg = <<-SVG.gsub(/^ {8}/, '') <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="#{width}" height="20"> <linearGradient id="b" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <clipPath id="a"> <rect width="#{width}" height="20" rx="3" fill="#fff"/> </clipPath> <g clip-path="url(#a)"> <path fill="#555" d="M0 0h93v20H0z"/> <path fill="##{color_for_coverage(coverage)}" d="M93 0h#{percent_string_length / 10 + 10}v20H93z"/> <path fill="url(#b)" d="M0 0h#{width}v20H0z"/> </g> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="830"> documentation </text> <text x="475" y="140" transform="scale(.1)" textLength="830"> documentation </text> <text x="#{percent_string_offset}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="#{percent_string_length}"> #{coverage}% </text> <text x="#{percent_string_offset}" y="140" transform="scale(.1)" textLength="#{percent_string_length}"> #{coverage}% </text> </g> </svg> SVG badge_output = .output + 'badge.svg' File.open(badge_output, 'w') { |f| f << svg } end |
.make_breadcrumbs(doc_model) ⇒ Object
Breadcrumbs for a page - doesn’t include the top ‘readme’ crumb
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/jazzy/doc_builder.rb', line 455 def self.(doc_model) return [] if doc_model.readme? docs_path = doc_model.docs_path = docs_path.map do |doc| { name: doc.name, url: doc.url, last: doc == doc_model, } end return if .count == 1 # Add the module name to the outer type if not clear from context if docs_path[1].ambiguous_module_name?(docs_path[0].name) [1][:name] = docs_path[1].fully_qualified_module_name end end |
.make_task(mark, uid, items, doc_model) ⇒ Object
rubocop:enable Metrics/MethodLength
387 388 389 390 391 392 393 394 395 396 |
# File 'lib/jazzy/doc_builder.rb', line 387 def self.make_task(mark, uid, items, doc_model) { name: mark.name, name_html: (render_inline(doc_model, mark.name) if mark.name), uid: ERB::Util.url_encode(uid), items: items, pre_separator: mark.has_start_dash, post_separator: mark.has_end_dash, } end |
.new_document(source_module, doc_model) ⇒ Object
Build Mustache document - common fields between page types
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/jazzy/doc_builder.rb', line 246 def self.new_document(source_module, doc_model) Doc.new.tap do |doc| doc[:custom_head] = Config.instance.custom_head doc[:disable_search] = Config.instance.disable_search doc[:doc_coverage] = source_module.doc_coverage unless Config.instance.hide_documentation_coverage doc[:structure] = source_module.doc_structure doc[:readme_title] = source_module.readme_title doc[:module_name] = doc[:readme_title] doc[:author_name] = source_module. if source_host = source_module.host doc[:source_host_name] = source_host.name doc[:source_host_url] = source_host.url doc[:source_host_image] = source_host.image doc[:source_host_item_url] = source_host.item_url(doc_model) doc[:github_url] = doc[:source_host_url] doc[:github_token_url] = doc[:source_host_item_url] end doc[:dash_url] = source_module.dash_feed_url doc[:breadcrumbs] = (doc_model) end end |
.prepare_output_dir(output_dir, clean) ⇒ Object
mkdir -p output directory and clean if option is set
26 27 28 29 |
# File 'lib/jazzy/doc_builder.rb', line 26 def self.prepare_output_dir(output_dir, clean) FileUtils.rm_r output_dir if clean && output_dir.directory? FileUtils.mkdir_p output_dir end |
.relative_path_if_inside(path, base_path) ⇒ Object
174 175 176 177 178 179 180 181 |
# File 'lib/jazzy/doc_builder.rb', line 174 def self.relative_path_if_inside(path, base_path) relative = path.relative_path_from(base_path) if relative.to_path =~ %r{/^..(/|$)/} path else relative end end |
.render(doc_model, markdown) ⇒ Object
235 236 237 238 |
# File 'lib/jazzy/doc_builder.rb', line 235 def self.render(doc_model, markdown) html = Markdown.render(markdown) SourceKitten.autolink_document(html, doc_model) end |
.render_inline(doc_model, markdown) ⇒ Object
240 241 242 243 |
# File 'lib/jazzy/doc_builder.rb', line 240 def self.render_inline(doc_model, markdown) html = Markdown.render_inline(markdown) SourceKitten.autolink_document(html, doc_model) end |
.render_item(item, source_module) ⇒ Object
Build mustache item for a top-level doc rubocop:disable Metrics/MethodLength
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/jazzy/doc_builder.rb', line 355 def self.render_item(item, source_module) # Combine abstract and discussion into abstract abstract = (item.abstract || '') + (item.discussion || '') source_host_item_url = source_module.host&.item_url(item) { name: item.name, name_html: item.name.gsub(':', ':<wbr>'), abstract: abstract, declaration: item.display_declaration, language: item.display_language, other_language_declaration: item.display_other_language_declaration, usr: item.usr, dash_type: item.type.dash_type, source_host_item_url: source_host_item_url, github_token_url: source_host_item_url, default_impl_abstract: item.default_impl_abstract, from_protocol_extension: item.from_protocol_extension, return: item.return, parameters: (item.parameters if item.parameters.any?), url: (item.url if item.render_as_page?), start_line: item.start_line, end_line: item.end_line, direct_link: item.omit_content_from_parent?, deprecation_message: item., unavailable_message: item., usage_discouraged: item.usage_discouraged?, async: item.async, declaration_note: item.declaration_note, } end |
.render_tasks(source_module, children) ⇒ Object
Render tasks for Mustache document
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/jazzy/doc_builder.rb', line 401 def self.render_tasks(source_module, children) marks = children.map(&:mark).uniq.compact mark_names_counts = {} marks.map do |mark| mark_children = children.select { |child| child.mark == mark } items = mark_children.map { |child| render_item(child, source_module) } uid = (mark.name || 'Unnamed').to_s if mark_names_counts.key?(uid) mark_names_counts[uid] += 1 uid += (mark_names_counts[uid]).to_s else mark_names_counts[uid] = 1 end make_task(mark, uid, items, mark_children.first) end end |
.undocumented_warnings(decls) ⇒ Object
183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/jazzy/doc_builder.rb', line 183 def self.undocumented_warnings(decls) decls.map do |decl| { file: decl.file, line: decl.start_line || decl.line, symbol: decl.fully_qualified_name, symbol_kind: decl.type.kind, warning: 'undocumented', } end end |
.write_lint_report(undocumented, options) ⇒ Object
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/jazzy/doc_builder.rb', line 195 def self.write_lint_report(undocumented, ) (.output + 'undocumented.json').open('w') do |f| warnings = undocumented_warnings(undocumented) lint_report = { warnings: warnings.sort_by do |w| [w[:file] || Pathname(''), w[:line] || 0, w[:symbol], w[:symbol_kind]] end, source_directory: .source_directory, } f.write(JSON.pretty_generate(lint_report)) end end |