double_doc 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -30,11 +30,11 @@ module DoubleDoc
30
30
  if match = line.match(/(^|\s+)@import\s+([^\s]+)\s*$/)
31
31
  doc << get_doc(match[2])
32
32
  else
33
- doc << line.gsub('@@import', '@import')
33
+ doc << line.gsub('@@import', '@import').rstrip
34
34
  end
35
35
  end
36
36
 
37
- doc.join()
37
+ doc.join("\n")
38
38
  end
39
39
 
40
40
  def get_doc(path)
@@ -1,4 +1,4 @@
1
1
  ## ## DoubleDoc 1.0
2
2
  module DoubleDoc
3
- VERSION = "1.0.0"
3
+ VERSION = "1.0.1"
4
4
  end
data/readme.md CHANGED
@@ -1,4 +1,5 @@
1
1
  ## DoubleDoc 1.0
2
+
2
3
  One of the challenges you face when writing public documention for code or APIs, is that you have to remember to update the documentation
3
4
  when ever you change the API. The main reason why this is a problem is that very often the documentation lives very for from your code.
4
5
 
@@ -42,17 +43,17 @@ You would then write a markdown document about your User API:
42
43
 
43
44
  ## Users
44
45
  You can acces users in our system by using our REST API, blah blah blah...
45
-
46
+
46
47
  @import app/controllers/users_controller.rb
47
48
 
48
49
  And DoubleDoc will generate this markdown document for you:
49
50
 
50
51
  ## Users
51
52
  You can acces users in our system by using our REST API, blah blah blah...
52
-
53
+
53
54
  ### Getting a User
54
55
  `GET /users/{id}.json`
55
-
56
+
56
57
  #### Format
57
58
  ```js
58
59
  {
@@ -62,7 +63,9 @@ And DoubleDoc will generate this markdown document for you:
62
63
  ```
63
64
 
64
65
  ### Rake Task
66
+
65
67
  You can easly use DoubleDoc from Rake, and soon I'll tell you how...
68
+
66
69
  ### TODO
67
70
  * Tests
68
71
  * Support for directory structures
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: double_doc
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -13,7 +13,7 @@ date: 2012-02-17 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: guard
16
- requirement: &70354882327720 !ruby/object:Gem::Requirement
16
+ requirement: &70269246238700 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '0'
22
22
  type: :development
23
23
  prerelease: false
24
- version_requirements: *70354882327720
24
+ version_requirements: *70269246238700
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: guard-rake
27
- requirement: &70354882327160 !ruby/object:Gem::Requirement
27
+ requirement: &70269246237960 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
32
32
  version: '0'
33
33
  type: :development
34
34
  prerelease: false
35
- version_requirements: *70354882327160
35
+ version_requirements: *70269246237960
36
36
  - !ruby/object:Gem::Dependency
37
37
  name: erubis
38
- requirement: &70354882326540 !ruby/object:Gem::Requirement
38
+ requirement: &70269246237320 !ruby/object:Gem::Requirement
39
39
  none: false
40
40
  requirements:
41
41
  - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
43
43
  version: '0'
44
44
  type: :runtime
45
45
  prerelease: false
46
- version_requirements: *70354882326540
46
+ version_requirements: *70269246237320
47
47
  - !ruby/object:Gem::Dependency
48
48
  name: redcarpet
49
- requirement: &70354882325760 !ruby/object:Gem::Requirement
49
+ requirement: &70269246236600 !ruby/object:Gem::Requirement
50
50
  none: false
51
51
  requirements:
52
52
  - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
54
54
  version: '0'
55
55
  type: :runtime
56
56
  prerelease: false
57
- version_requirements: *70354882325760
57
+ version_requirements: *70269246236600
58
58
  - !ruby/object:Gem::Dependency
59
59
  name: pygments.rb
60
- requirement: &70354882325200 !ruby/object:Gem::Requirement
60
+ requirement: &70269246235800 !ruby/object:Gem::Requirement
61
61
  none: false
62
62
  requirements:
63
63
  - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
65
65
  version: '0'
66
66
  type: :runtime
67
67
  prerelease: false
68
- version_requirements: *70354882325200
68
+ version_requirements: *70269246235800
69
69
  description: A simple framework for writing and generating beautiful documentation
70
70
  for your code
71
71
  email: