rdoc-markdown 0.4 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 701b08501deaf21f981b61001ec79249d506f685a755b0931ccb40f19a93690f
4
- data.tar.gz: e3d5b50d3599a08004aaa182426477adeaeb539ff0215a92cd10485007282c88
3
+ metadata.gz: df1f3da8afd7010551e9edbaf2f33de617d63584760e3c59120c6f3b38232f19
4
+ data.tar.gz: 82b591023300cf619230ef8786b3ae10ed3cb5d2aadae9afcd43b5da4c0528b7
5
5
  SHA512:
6
- metadata.gz: 79c8b70b7e4a2e5b1a763d66cb8e8210c8b51250c1afdcb0de9fb5a96607f3347f060731540426b7641767d1cd6bd50ad8be3a56749facdc16e3cb8e93c4c704
7
- data.tar.gz: 051f1cf3cc914fededfebb6db13d0c121b82e5e01de1b51f43a5af27f886929a0b6a3ddea27c7691ea6d46707778c290be142483e065146e2fc0e7db4b131b48
6
+ metadata.gz: ac5335f705812d01d5bd24488cda5fb77ce69f8fa6b32677b13f048aab476062c0845681324f3b05de9c0965bbcc2c0f1c64dbb5e4f58dc5ee8a8c4a8906dd33
7
+ data.tar.gz: b682c9b99cace11662bff88be24560b370a2b8a084ec9fac47a854e90a0bfdfafd246e4c62d9c84055c426bcaf3572d1f69bb2e0d02aacc838a7be46e6da8b01
data/Gemfile CHANGED
@@ -8,5 +8,3 @@ gemspec
8
8
  gem "rake", "~> 13.0"
9
9
 
10
10
  gem "minitest", "~> 5.0"
11
-
12
- gem "standard", "~> 1.3"
data/Gemfile.lock CHANGED
@@ -1,68 +1,60 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- rdoc-markdown (0.4)
5
- erb (~> 2.0)
6
- extralite-bundle (~> 1.0)
7
- rdoc (~> 6.0)
8
- reverse_markdown (~> 2.0)
9
- unindent (~> 1.0)
4
+ rdoc-markdown (0.5.0)
5
+ csv
6
+ erb
7
+ rdoc
8
+ reverse_markdown
9
+ unindent
10
10
 
11
11
  GEM
12
12
  remote: https://rubygems.org/
13
13
  specs:
14
- ast (2.4.2)
15
- cgi (0.3.3)
16
- erb (2.2.3)
17
- cgi
18
- extralite-bundle (1.17)
19
- json (2.6.2)
20
- minitest (5.16.3)
21
- nokogiri (1.13.9-arm64-darwin)
14
+ cgi (0.4.1)
15
+ csv (3.3.2)
16
+ date (3.4.1)
17
+ erb (4.0.4)
18
+ cgi (>= 0.3.3)
19
+ minitest (5.25.4)
20
+ nokogiri (1.18.0-aarch64-linux-gnu)
22
21
  racc (~> 1.4)
23
- nokogiri (1.13.9-x86_64-linux)
22
+ nokogiri (1.18.0-aarch64-linux-musl)
24
23
  racc (~> 1.4)
25
- parallel (1.22.1)
26
- parser (3.1.2.1)
27
- ast (~> 2.4.1)
28
- psych (4.0.6)
24
+ nokogiri (1.18.0-arm-linux-gnu)
25
+ racc (~> 1.4)
26
+ nokogiri (1.18.0-arm-linux-musl)
27
+ racc (~> 1.4)
28
+ nokogiri (1.18.0-arm64-darwin)
29
+ racc (~> 1.4)
30
+ nokogiri (1.18.0-x86_64-darwin)
31
+ racc (~> 1.4)
32
+ nokogiri (1.18.0-x86_64-linux-gnu)
33
+ racc (~> 1.4)
34
+ nokogiri (1.18.0-x86_64-linux-musl)
35
+ racc (~> 1.4)
36
+ psych (5.2.2)
37
+ date
29
38
  stringio
30
- racc (1.6.0)
31
- rainbow (3.1.1)
32
- rake (13.0.6)
33
- rdiscount (2.2.7)
34
- rdoc (6.4.0)
39
+ racc (1.8.1)
40
+ rake (13.2.1)
41
+ rdiscount (2.2.7.3)
42
+ rdoc (6.10.0)
35
43
  psych (>= 4.0.0)
36
- regexp_parser (2.6.1)
37
- reverse_markdown (2.1.1)
44
+ reverse_markdown (3.0.0)
38
45
  nokogiri
39
- rexml (3.2.5)
40
- rubocop (1.39.0)
41
- json (~> 2.3)
42
- parallel (~> 1.10)
43
- parser (>= 3.1.2.1)
44
- rainbow (>= 2.2.2, < 4.0)
45
- regexp_parser (>= 1.8, < 3.0)
46
- rexml (>= 3.2.5, < 4.0)
47
- rubocop-ast (>= 1.23.0, < 2.0)
48
- ruby-progressbar (~> 1.7)
49
- unicode-display_width (>= 1.4.0, < 3.0)
50
- rubocop-ast (1.23.0)
51
- parser (>= 3.1.1.0)
52
- rubocop-performance (1.15.1)
53
- rubocop (>= 1.7.0, < 2.0)
54
- rubocop-ast (>= 0.4.0)
55
- ruby-progressbar (1.11.0)
56
- standard (1.18.1)
57
- rubocop (= 1.39.0)
58
- rubocop-performance (= 1.15.1)
59
- stringio (3.0.2)
60
- unicode-display_width (2.3.0)
46
+ stringio (3.1.2)
61
47
  unindent (1.0)
62
48
 
63
49
  PLATFORMS
64
- arm64-darwin-21
65
- x86_64-linux
50
+ aarch64-linux-gnu
51
+ aarch64-linux-musl
52
+ arm-linux-gnu
53
+ arm-linux-musl
54
+ arm64-darwin
55
+ x86_64-darwin
56
+ x86_64-linux-gnu
57
+ x86_64-linux-musl
66
58
 
67
59
  DEPENDENCIES
68
60
  bundler (~> 2.0)
@@ -70,7 +62,6 @@ DEPENDENCIES
70
62
  rake (~> 13.0)
71
63
  rdiscount (~> 2.0)
72
64
  rdoc-markdown!
73
- standard (~> 1.3)
74
65
 
75
66
  BUNDLED WITH
76
- 2.3.20
67
+ 2.6.1
data/README.md CHANGED
@@ -1,9 +1,6 @@
1
1
  # RDoc-Markdown
2
2
  RDoc plugin to generate markdown documentation and search index backed by sqlite database.
3
3
 
4
- ## Motivation
5
- I'm trying to depend less on software with GUI, instead using software that could be used through console. **Documentation in markdown format allows me to review documentation in console**, instead of browser or GUI software like DevDocs.
6
-
7
4
  ## Installation
8
5
 
9
6
  Install gem and add to application's Gemfile by executing:
@@ -22,7 +19,7 @@ RDoc will auto-detect rdoc-markdown plugin if it was installed. You just need to
22
19
 
23
20
  Run following command in directory with ruby source code:
24
21
 
25
- `rdoc --format=markdown --markup=markdown`
22
+ `rdoc --format=markdown`
26
23
 
27
24
  This will produce a tree of markdown documents and search index in `/doc` folder. Every class in library will have it's own markdown file.
28
25
 
data/Rakefile CHANGED
@@ -1,6 +1,5 @@
1
1
  require "bundler/gem_tasks"
2
2
  require "rake/testtask"
3
- require "standard/rake"
4
3
 
5
4
  Rake::TestTask.new do |t|
6
5
  t.verbose = true
@@ -8,4 +7,4 @@ Rake::TestTask.new do |t|
8
7
  t.test_files = FileList["test/test*.rb"]
9
8
  end
10
9
 
11
- task default: [:test, "standard:fix"]
10
+ task default: [:test]
data/example/Bird.md CHANGED
@@ -7,10 +7,11 @@ The base class for all birds.
7
7
 
8
8
  Flying is the most critical feature of birds.
9
9
 
10
- = Example
11
-
12
- fly(:south, 70)
10
+ # Example[¶](#method-i-fly-label-Example) [↑](#top)
13
11
 
12
+ ```
13
+ fly(:south,70)
14
+ ```
14
15
  ### speak() { |text| ... } [](#method-i-speak)
15
16
  Produce some noise.
16
17
 
data/example/Duck.md CHANGED
@@ -3,21 +3,22 @@ A duck is a [`Waterfowl`](Waterfowl.html) [`Bird`](Bird.html).
3
3
 
4
4
  Features:
5
5
 
6
+ ```
6
7
  bird::
7
8
 
8
- - speak
9
-
10
- - fly
9
+ * speak
10
+ * fly
11
11
 
12
12
  waterfowl::
13
13
 
14
- - swim
15
-
14
+ * swim
15
+ ```
16
16
  ## Constants
17
17
  | Name | Description |
18
18
  | ---- | ----------- |
19
19
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
20
- ## Bird overrides ## Constants
20
+ # Bird overrides
21
+ ## Constants
21
22
  | Name | Description |
22
23
  | ---- | ----------- |
23
24
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
@@ -25,7 +26,8 @@ waterfowl::
25
26
  ### speak() { |speech| ... } [](#method-i-speak)
26
27
  [`Duck`](Duck.html) overrides generic implementation.
27
28
 
28
- ## Duck extensions ## Constants
29
+ # Duck extensions
30
+ ## Constants
29
31
  | Name | Description |
30
32
  | ---- | ----------- |
31
33
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
data/example/index.csv ADDED
@@ -0,0 +1,16 @@
1
+ name,type,path
2
+ Bird,Class,Bird.md
3
+ Bird.speak,Method,Bird.md#method-i-speak
4
+ Bird.fly,Method,Bird.md#method-i-fly
5
+ Duck,Class,Duck.md
6
+ Duck.speak,Method,Duck.md#method-i-speak
7
+ Duck.rubber_ducks,Method,Duck.md#method-c-rubber_ducks
8
+ Duck.new,Method,Duck.md#method-c-new
9
+ Duck.useful?,Method,Duck.md#method-i-useful-3F
10
+ Duck.MAX_VELOCITY,Constant,Duck.md#MAX_VELOCITY
11
+ Duck.domestic,Attribute,Duck.md#attribute-i-domestic
12
+ Duck.rubber,Attribute,Duck.md#attribute-i-rubber
13
+ Object,Class,Object.md
14
+ Object.DEFAULT_DUCK_VELOCITY,Constant,Object.md#DEFAULT_DUCK_VELOCITY
15
+ Waterfowl,Module,Waterfowl.md
16
+ Waterfowl.swim,Method,Waterfowl.md#method-i-swim
data/lib/rdoc/discover.rb CHANGED
@@ -1 +1,7 @@
1
- require "markdown"
1
+ begin
2
+ require "markdown"
3
+ rescue LoadError => error
4
+ puts error
5
+ end
6
+
7
+ puts "rdoc-markdown was discovered" if $DEBUG
@@ -5,8 +5,8 @@ gem "rdoc"
5
5
  require "pathname"
6
6
  require "erb"
7
7
  require "reverse_markdown"
8
- require "extralite"
9
8
  require "unindent"
9
+ require "csv"
10
10
 
11
11
  class RDoc::Generator::Markdown
12
12
  RDoc::RDoc.add_generator self
@@ -14,9 +14,7 @@ class RDoc::Generator::Markdown
14
14
  ##
15
15
  # Defines a constant for directory where templates could be found
16
16
 
17
- TEMPLATE_DIR = File.expand_path(
18
- File.join(File.dirname(__FILE__), "..", "..", "templates")
19
- )
17
+ TEMPLATE_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "templates"))
20
18
 
21
19
  ##
22
20
  # The RDoc::Store that is the source of the generated content
@@ -62,8 +60,6 @@ class RDoc::Generator::Markdown
62
60
  # Generates markdown files and search index file
63
61
 
64
62
  def generate
65
- # TODO: Make sure to set --markup parameter to 'markdown'.
66
-
67
63
  debug("Setting things up #{@output_dir}")
68
64
 
69
65
  setup
@@ -72,9 +68,9 @@ class RDoc::Generator::Markdown
72
68
 
73
69
  emit_classfiles
74
70
 
75
- debug("Generate search index in #{output_dir}/index.db")
71
+ debug("Generate index file in #{@output_dir}")
76
72
 
77
- emit_sqlite
73
+ emit_csv_index
78
74
  end
79
75
 
80
76
  private
@@ -96,56 +92,52 @@ class RDoc::Generator::Markdown
96
92
  # This class emits a search index for generated documentation as sqlite database
97
93
  #
98
94
 
99
- def emit_sqlite(name = "index.db")
100
- db = Extralite::Database.new("#{output_dir}/#{name}")
101
-
102
- db.execute <<-SQL
103
- create table contentIndex (
104
- id INTEGER PRIMARY KEY,
105
- name TEXT,
106
- type TEXT,
107
- path TEXT
108
- );
109
- SQL
110
-
111
- result = []
112
-
113
- @classes.map do |klass|
114
- result << {
115
- name: klass.full_name,
116
- type: klass.type.capitalize,
117
- path: turn_to_path(klass.full_name)
118
- }
119
-
120
- klass.method_list.each do |method|
121
- next if method.visibility.to_s.eql?("private")
122
-
123
- result << {
124
- name: "#{klass.full_name}.#{method.name}",
125
- type: "Method",
126
- path: "#{turn_to_path(klass.full_name)}##{method.aref}"
127
- }
128
- end
129
-
130
- klass.constants.sort_by { |x| x.name }.each do |const|
131
- result << {
132
- name: "#{klass.full_name}.#{const.name}",
133
- type: "Constant",
134
- path: "#{turn_to_path(klass.full_name)}##{const.name}"
135
- }
95
+ def emit_csv_index(name = "index.csv")
96
+ filepath = "#{output_dir}/#{name}"
97
+
98
+ CSV.open(filepath, "wb") do |csv|
99
+ csv << %w[name type path]
100
+
101
+ @classes.map do |klass|
102
+ csv << [
103
+ klass.full_name,
104
+ klass.type.capitalize,
105
+ turn_to_path(klass.full_name),
106
+ ]
107
+
108
+ klass.method_list.each do |method|
109
+ next if method.visibility.to_s.eql?("private")
110
+ next if method.visibility.to_s.eql?("protected")
111
+
112
+ csv << [
113
+ "#{klass.full_name}.#{method.name}",
114
+ "Method",
115
+ "#{turn_to_path(klass.full_name)}##{method.aref}",
116
+ ]
117
+ end
118
+
119
+ klass
120
+ .constants
121
+ .sort_by { |x| x.name }
122
+ .each do |const|
123
+ csv << [
124
+ "#{klass.full_name}.#{const.name}",
125
+ "Constant",
126
+ "#{turn_to_path(klass.full_name)}##{const.name}",
127
+ ]
128
+ end
129
+
130
+ klass
131
+ .attributes
132
+ .sort_by { |x| x.name }
133
+ .each do |attr|
134
+ csv << [
135
+ "#{klass.full_name}.#{attr.name}",
136
+ "Attribute",
137
+ "#{turn_to_path(klass.full_name)}##{attr.aref}",
138
+ ]
139
+ end
136
140
  end
137
-
138
- klass.attributes.sort_by { |x| x.name }.each do |attr|
139
- result << {
140
- name: "#{klass.full_name}.#{attr.name}",
141
- type: "Attribute",
142
- path: "#{turn_to_path(klass.full_name)}##{attr.aref}"
143
- }
144
- end
145
- end
146
-
147
- result.each do |rec|
148
- db.execute "insert into contentIndex (name, type, path) values (:name, :type, :path)", rec
149
141
  end
150
142
  end
151
143
 
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Rdoc
4
4
  module Markdown
5
- VERSION = "0.4"
5
+ VERSION = "0.5.0"
6
6
  end
7
7
  end
@@ -1,8 +1,12 @@
1
1
  # <%= klass.type %> <%= klass.full_name %> [](#<%= klass.aref.strip %>) [](#top)
2
2
  <%= h klass.description %>
3
3
  <% klass.each_section do |section, constants, attributes| %>
4
- <% if section.title %>## <%= section.title.strip %> <% end %>
5
- <% if section.comment %> <%=h section.description %><% end%>
4
+ <% if section.title %># <%= section.title.strip %>
5
+
6
+ <% end %>
7
+ <% if section.comment %> <%=h section.description %>
8
+
9
+ <%end%>
6
10
  <% unless klass.constants.empty? %>
7
11
  ## Constants
8
12
  | Name | Description |
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/rdoc/markdown/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "rdoc-markdown"
7
+ spec.version = Rdoc::Markdown::VERSION
8
+ spec.authors = ["Stanislav (Stas) Katkov"]
9
+ spec.email = ["github@skatkov.com"]
10
+ spec.license = "GPL-3.0-or-later"
11
+
12
+ spec.summary = "RDoc plugin to generate markdown documentation "
13
+ spec.description = "RDoc plugin to generate markdown documentation and search index as sqlite database for entire content."
14
+ spec.homepage = "https://poshtui.com"
15
+ spec.required_ruby_version = ">= 2.7.0"
16
+
17
+ # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
18
+
19
+ spec.metadata["homepage_uri"] = spec.homepage
20
+ spec.metadata["source_code_uri"] = "https://github.com/skatkov/rdoc-markdown"
21
+ spec.metadata["changelog_uri"] = "https://github.com/skatkov/rdoc-markdown"
22
+
23
+ # Specify which files should be added to the gem when it is released.
24
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
25
+ spec.files = Dir.chdir(__dir__) do
26
+ `git ls-files -z`.split("\x0").reject do |f|
27
+ (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
28
+ end
29
+ end
30
+ spec.bindir = "exe"
31
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
32
+ spec.require_paths = ["lib"]
33
+
34
+ spec.add_dependency "rdoc"
35
+ spec.add_dependency "erb"
36
+ spec.add_dependency "reverse_markdown"
37
+ spec.add_dependency "unindent"
38
+ spec.add_dependency "csv"
39
+
40
+ spec.add_development_dependency "minitest", "~> 5.0"
41
+ spec.add_development_dependency "rake", "~> 13.0"
42
+ spec.add_development_dependency "bundler", "~> 2.0"
43
+ spec.add_development_dependency "rdiscount", "~> 2.0"
44
+ end
metadata CHANGED
@@ -1,85 +1,84 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rdoc-markdown
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.4'
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stanislav (Stas) Katkov
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2022-11-21 00:00:00.000000000 Z
10
+ date: 2024-12-28 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: rdoc
15
14
  requirement: !ruby/object:Gem::Requirement
16
15
  requirements:
17
- - - "~>"
16
+ - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: '6.0'
18
+ version: '0'
20
19
  type: :runtime
21
20
  prerelease: false
22
21
  version_requirements: !ruby/object:Gem::Requirement
23
22
  requirements:
24
- - - "~>"
23
+ - - ">="
25
24
  - !ruby/object:Gem::Version
26
- version: '6.0'
25
+ version: '0'
27
26
  - !ruby/object:Gem::Dependency
28
27
  name: erb
29
28
  requirement: !ruby/object:Gem::Requirement
30
29
  requirements:
31
- - - "~>"
30
+ - - ">="
32
31
  - !ruby/object:Gem::Version
33
- version: '2.0'
32
+ version: '0'
34
33
  type: :runtime
35
34
  prerelease: false
36
35
  version_requirements: !ruby/object:Gem::Requirement
37
36
  requirements:
38
- - - "~>"
37
+ - - ">="
39
38
  - !ruby/object:Gem::Version
40
- version: '2.0'
39
+ version: '0'
41
40
  - !ruby/object:Gem::Dependency
42
41
  name: reverse_markdown
43
42
  requirement: !ruby/object:Gem::Requirement
44
43
  requirements:
45
- - - "~>"
44
+ - - ">="
46
45
  - !ruby/object:Gem::Version
47
- version: '2.0'
46
+ version: '0'
48
47
  type: :runtime
49
48
  prerelease: false
50
49
  version_requirements: !ruby/object:Gem::Requirement
51
50
  requirements:
52
- - - "~>"
51
+ - - ">="
53
52
  - !ruby/object:Gem::Version
54
- version: '2.0'
53
+ version: '0'
55
54
  - !ruby/object:Gem::Dependency
56
- name: extralite-bundle
55
+ name: unindent
57
56
  requirement: !ruby/object:Gem::Requirement
58
57
  requirements:
59
- - - "~>"
58
+ - - ">="
60
59
  - !ruby/object:Gem::Version
61
- version: '1.0'
60
+ version: '0'
62
61
  type: :runtime
63
62
  prerelease: false
64
63
  version_requirements: !ruby/object:Gem::Requirement
65
64
  requirements:
66
- - - "~>"
65
+ - - ">="
67
66
  - !ruby/object:Gem::Version
68
- version: '1.0'
67
+ version: '0'
69
68
  - !ruby/object:Gem::Dependency
70
- name: unindent
69
+ name: csv
71
70
  requirement: !ruby/object:Gem::Requirement
72
71
  requirements:
73
- - - "~>"
72
+ - - ">="
74
73
  - !ruby/object:Gem::Version
75
- version: '1.0'
74
+ version: '0'
76
75
  type: :runtime
77
76
  prerelease: false
78
77
  version_requirements: !ruby/object:Gem::Requirement
79
78
  requirements:
80
- - - "~>"
79
+ - - ">="
81
80
  - !ruby/object:Gem::Version
82
- version: '1.0'
81
+ version: '0'
83
82
  - !ruby/object:Gem::Dependency
84
83
  name: minitest
85
84
  requirement: !ruby/object:Gem::Requirement
@@ -122,20 +121,6 @@ dependencies:
122
121
  - - "~>"
123
122
  - !ruby/object:Gem::Version
124
123
  version: '2.0'
125
- - !ruby/object:Gem::Dependency
126
- name: standard
127
- requirement: !ruby/object:Gem::Requirement
128
- requirements:
129
- - - "~>"
130
- - !ruby/object:Gem::Version
131
- version: '1.0'
132
- type: :development
133
- prerelease: false
134
- version_requirements: !ruby/object:Gem::Requirement
135
- requirements:
136
- - - "~>"
137
- - !ruby/object:Gem::Version
138
- version: '1.0'
139
124
  - !ruby/object:Gem::Dependency
140
125
  name: rdiscount
141
126
  requirement: !ruby/object:Gem::Requirement
@@ -159,7 +144,6 @@ extensions: []
159
144
  extra_rdoc_files: []
160
145
  files:
161
146
  - ".editorconfig"
162
- - ".standard.yml"
163
147
  - CODE_OF_CONDUCT.md
164
148
  - Gemfile
165
149
  - Gemfile.lock
@@ -169,20 +153,14 @@ files:
169
153
  - example/Bird.md
170
154
  - example/Duck.md
171
155
  - example/Object.md
172
- - example/RDoc.md
173
- - example/RDoc/Generator.md
174
- - example/RDoc/Generator/Markdown.md
175
- - example/RDoc/Markdown.md
176
- - example/Rdoc.md
177
- - example/Rdoc/Markdown.md
178
- - example/TestGenerator.md
179
156
  - example/Waterfowl.md
180
- - example/index.db
157
+ - example/index.csv
181
158
  - lib/markdown.rb
182
159
  - lib/rdoc/discover.rb
183
160
  - lib/rdoc/generator/markdown.rb
184
161
  - lib/rdoc/markdown/version.rb
185
162
  - lib/templates/classfile.md.erb
163
+ - rdoc-markdown.gemspec
186
164
  - sig/rdoc/markdown.rbs
187
165
  homepage: https://poshtui.com
188
166
  licenses:
@@ -191,7 +169,6 @@ metadata:
191
169
  homepage_uri: https://poshtui.com
192
170
  source_code_uri: https://github.com/skatkov/rdoc-markdown
193
171
  changelog_uri: https://github.com/skatkov/rdoc-markdown
194
- post_install_message:
195
172
  rdoc_options: []
196
173
  require_paths:
197
174
  - lib
@@ -206,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
206
183
  - !ruby/object:Gem::Version
207
184
  version: '0'
208
185
  requirements: []
209
- rubygems_version: 3.1.6
210
- signing_key:
186
+ rubygems_version: 3.6.2
211
187
  specification_version: 4
212
188
  summary: RDoc plugin to generate markdown documentation
213
189
  test_files: []
data/.standard.yml DELETED
@@ -1,10 +0,0 @@
1
- # For available configuration options, see:
2
- # https://github.com/testdouble/standard
3
- ruby_version: 2.7
4
- parallel: true
5
- format: progress
6
-
7
- ignore:
8
- - 'docs/example.rb'
9
- - '**/*':
10
- - Style/GlobalVars
@@ -1,30 +0,0 @@
1
- # class RDoc::Generator::Markdown [](#class-RDoc::Generator::Markdown) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **TEMPLATE_DIR[](#TEMPLATE_DIR)** | Defines a constant for directory where templates could be found |
6
- ## Attributes
7
- ### base_dir[R] [](#attribute-i-base_dir)
8
- The path to generate files into, combined with `--op` from the options for a full path.
9
-
10
- ### classes[R] [](#attribute-i-classes)
11
- Classes and modules to be used by this generator, not necessarily displayed.
12
-
13
- ### store[R] [](#attribute-i-store)
14
- The RDoc::Store that is the source of the generated content
15
-
16
- ## Public Class Methods
17
- ### new(store, options) [](#method-c-new)
18
- Initializer method for Rdoc::Generator::Markdown
19
-
20
- ## Public Instance Methods
21
- ### class_dir() [](#method-i-class_dir)
22
- Directory where generated class HTML files live relative to the output dir.
23
-
24
- ### file_dir() [](#method-i-file_dir)
25
- this alias is required for rdoc to work
26
-
27
- ### generate() [](#method-i-generate)
28
- Generates markdown files and search index file
29
-
30
-
@@ -1,2 +0,0 @@
1
- # module RDoc::Generator [](#module-RDoc::Generator) [](#top)
2
-
@@ -1,2 +0,0 @@
1
- # class RDoc::Markdown [](#class-RDoc::Markdown) [](#top)
2
-
data/example/RDoc.md DELETED
@@ -1,2 +0,0 @@
1
- # module RDoc [](#module-RDoc) [](#top)
2
-
@@ -1,6 +0,0 @@
1
- # module Rdoc::Markdown [](#module-Rdoc::Markdown) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **VERSION[](#VERSION)** | Not documented |
6
-
data/example/Rdoc.md DELETED
@@ -1,2 +0,0 @@
1
- # module Rdoc [](#module-Rdoc) [](#top)
2
-
@@ -1,10 +0,0 @@
1
- # class TestGenerator [](#class-TestGenerator) [](#top)
2
- ## Constants
3
- | Name | Description |
4
- | ---- | ----------- |
5
- | **CLASSES[](#CLASSES)** | Not documented |
6
- ## Public Instance Methods
7
- ### run_generator(file, title) { |options| ... } [](#method-i-run_generator)
8
- ### source_file() [](#method-i-source_file)
9
- ### test_generator() [](#method-i-test_generator)
10
-
data/example/index.db DELETED
Binary file