boondoc 0.1.0

data/lib/boondoc.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'prism'
+
+require_relative 'boondoc/version'
+
+# Markdown-only API documentation for Ruby.
+#
+# Source is parsed with Prism into a {Boondoc::Model::Registry}, and every class
+# and module is rendered to its own markdown file. See {Boondoc::Generator} for
+# the pipeline and {Boondoc::CLI} for the command line.
+module Boondoc
+  # Raised for any failure Boondoc reports to the user.
+  class Error < StandardError; end
+end
+
+require_relative 'boondoc/reporter'
+require_relative 'boondoc/containment'
+require_relative 'boondoc/yardopts'
+require_relative 'boondoc/config'
+require_relative 'boondoc/markdown'
+require_relative 'boondoc/model/docstring'
+require_relative 'boondoc/model/code_object'
+require_relative 'boondoc/model/registry'
+require_relative 'boondoc/type_parser'
+require_relative 'boondoc/docstring_parser'
+require_relative 'boondoc/frontend/comments'
+require_relative 'boondoc/frontend/visitor'
+require_relative 'boondoc/frontend/prism_parser'
+require_relative 'boondoc/yard_bridge'
+require_relative 'boondoc/references'
+require_relative 'boondoc/filter'
+require_relative 'boondoc/path_map'
+require_relative 'boondoc/links'
+require_relative 'boondoc/assets'
+require_relative 'boondoc/stitcher'
+require_relative 'boondoc/core_constants'
+require_relative 'boondoc/linker'
+require_relative 'boondoc/context'
+require_relative 'boondoc/renderer/base'
+require_relative 'boondoc/renderer/docstring'
+require_relative 'boondoc/renderer/method_section'
+require_relative 'boondoc/renderer/namespace_page'
+require_relative 'boondoc/renderer/index'
+require_relative 'boondoc/writer'
+require_relative 'boondoc/generator'
+require_relative 'boondoc/preview'
+require_relative 'boondoc/cli'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: boondoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Sharp
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'boondoc reads YARD-style tags from Ruby source using Prism and writes
+  plain GitHub-flavored markdown: one file per class or module, with working relative
+  links, plus your README and guides stitched in. No HTML, no site to deploy and host.'
+email:
+- joesharp13@gmail.com
+executables:
+- boondoc
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/boondoc
+- lib/boondoc.rb
+- lib/boondoc/assets.rb
+- lib/boondoc/cli.rb
+- lib/boondoc/config.rb
+- lib/boondoc/containment.rb
+- lib/boondoc/context.rb
+- lib/boondoc/core_constants.rb
+- lib/boondoc/docstring_parser.rb
+- lib/boondoc/filter.rb
+- lib/boondoc/frontend/comments.rb
+- lib/boondoc/frontend/prism_parser.rb
+- lib/boondoc/frontend/visitor.rb
+- lib/boondoc/generator.rb
+- lib/boondoc/linker.rb
+- lib/boondoc/links.rb
+- lib/boondoc/markdown.rb
+- lib/boondoc/model/code_object.rb
+- lib/boondoc/model/docstring.rb
+- lib/boondoc/model/registry.rb
+- lib/boondoc/path_map.rb
+- lib/boondoc/preview.rb
+- lib/boondoc/rake_task.rb
+- lib/boondoc/references.rb
+- lib/boondoc/renderer/base.rb
+- lib/boondoc/renderer/docstring.rb
+- lib/boondoc/renderer/index.rb
+- lib/boondoc/renderer/method_section.rb
+- lib/boondoc/renderer/namespace_page.rb
+- lib/boondoc/reporter.rb
+- lib/boondoc/stitcher.rb
+- lib/boondoc/type_parser.rb
+- lib/boondoc/version.rb
+- lib/boondoc/writer.rb
+- lib/boondoc/yard_bridge.rb
+- lib/boondoc/yardopts.rb
+homepage: https://github.com/joe-sharp/boondoc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joe-sharp/boondoc
+  source_code_uri: https://github.com/joe-sharp/boondoc/tree/v0.1.0
+  bug_tracker_uri: https://github.com/joe-sharp/boondoc/issues
+  changelog_uri: https://github.com/joe-sharp/boondoc/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Markdown-only API documentation for Ruby, written from YARD-style comments
+test_files: []