mathjax-yard 1.0.2 → 1.0.3

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.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/.#Rakefile +1 -0
  3. data/.yardopts +1 -3
  4. data/README.md +70 -37
  5. data/Rakefile +8 -9
  6. data/doc/MathJaxYard.html +47 -47
  7. data/doc/MathJaxYard/Command.html +289 -182
  8. data/doc/Mathjax-yard_design_20160624.png +0 -0
  9. data/doc/_index.html +38 -33
  10. data/doc/class_list.html +24 -31
  11. data/doc/css/full_list.css +32 -31
  12. data/doc/css/style.css +220 -78
  13. data/doc/file.CODE_OF_CONDUCT.html +132 -0
  14. data/doc/file.Home.html +119 -66
  15. data/doc/file.README.html +119 -66
  16. data/doc/file.README_ja.html +119 -66
  17. data/doc/file.Why_mathjax-yard.html +29 -30
  18. data/doc/file.Why_mathjax-yard.mjx.html +29 -30
  19. data/doc/file.atom.html +30 -31
  20. data/doc/file.atom.mjx.html +30 -31
  21. data/doc/file.left_issue.html +111 -0
  22. data/doc/file.potential.html +29 -30
  23. data/doc/file.potential.mjx.html +29 -30
  24. data/doc/file_list.html +60 -38
  25. data/doc/frames.html +7 -16
  26. data/doc/index.html +119 -66
  27. data/doc/js/app.js +100 -76
  28. data/doc/js/full_list.js +170 -135
  29. data/doc/method_list.html +96 -68
  30. data/doc/top-level-namespace.html +48 -50
  31. data/hikis/Mathjax-yard_design_20160624.pdf +0 -0
  32. data/hikis/Mathjax-yard_design_20160624.png +0 -0
  33. data/{docs → hikis}/README_ja.hiki +68 -37
  34. data/{docs → hikis}/Why_mathjax-yard.hiki +0 -0
  35. data/{docs → hikis}/atom.hiki +1 -1
  36. data/hikis/left_issue.hiki +19 -0
  37. data/{docs → hikis}/potential.hiki +0 -0
  38. data/lib/mathjax-yard.rb +26 -0
  39. data/lib/mathjax-yard/init.rb +1 -1
  40. data/lib/mathjax-yard/version.rb +1 -1
  41. data/mathjax-yard.gemspec +2 -1
  42. data/mathjax.yml +4 -3
  43. metadata +28 -9
  44. data/mathjax.yml.bk +0 -28
File without changes
@@ -21,7 +21,7 @@ $$
21
21
  うまく表現することが可能となった.詳しくは西谷・赤本参照.
22
22
 
23
23
  ## 具体例
24
- EAM potentialにおいて単原子空孔の生成エネルギEvは
24
+ EAM potentialにおいて単原子空孔の生成エネルギ$E_v$は
25
25
 
26
26
  $$
27
27
  E_v = -\frac{E_c}{2}\frac{2-poq}{1-poq}
@@ -0,0 +1,19 @@
1
+ !やり残したことの検討結果
2
+ !! -t mathjaxでの選択
3
+ yard生成時にいまはすべての書類にmathjaxをtemplateにしている.
4
+ これでは,本来のhtml記法での\$\$が別の意味となる.
5
+ 特に,methodなどのcode解説において斜体表示となり,残念.
6
+
7
+ !!! yardでの対応
8
+ * *.mjx.mdを別にyardがけする
9
+ * .yardoptsの記述を変える.
10
+ * Rakeのなかでtask.files, task.optionsで対応させようとしたが,うまく動作しない.
11
+
12
+ 実装してみたが,成功してない.
13
+
14
+ !!! mathjaxでの対応
15
+ 実際はRakefileでの対応となるが,
16
+
17
+ * mathjaxでひっかかったのを別フォルダーにして,yardを変える.
18
+
19
+ まだ,トライしてない.いずれにしろ,task.optionsの挙動制御は必要
File without changes
@@ -43,6 +43,7 @@ module MathJaxYard
43
43
  }
44
44
  opt.on('-i', '--init','init for mathjax on yard layout.') {
45
45
  init_yard()
46
+ init_mathjax_yard()
46
47
  exit
47
48
  }
48
49
  end
@@ -57,6 +58,31 @@ EOF
57
58
  exit
58
59
  end
59
60
 
61
+ def init_mathjax_yard
62
+ text = <<EOS
63
+
64
+ Following hand operations are necessary.
65
+
66
+ Add on ./yardopts
67
+
68
+ -t mathjax -p templates
69
+
70
+ Add on Rakefile
71
+
72
+ desc "arrange yard target by mathjax-yard"
73
+ task :pre_math do
74
+ system('mathjax-yard')
75
+ end
76
+
77
+ desc "make yard documents with yardmath"
78
+ task :myard => [:hiki2md, :pre_math,:yard] do
79
+ system('mathjax-yard --post')
80
+ end
81
+
82
+ EOS
83
+ puts text
84
+ end
85
+
60
86
  def post_operation
61
87
  src = File.read("./mathjax.yml")
62
88
  p data = YAML.load(src)
@@ -7,7 +7,7 @@ module MathJaxYard
7
7
  full_path="#{target_dir}/#{tmp_dir}/layout/html/layout.erb"
8
8
  if File.exist?("#{tmp_dir}/layout/html/layout.erb")
9
9
  print("file #{full_path} exists.\nDelete them first.\n")
10
- exit
10
+ return
11
11
  end
12
12
  FileUtils.cp_r('default',tmp_dir)
13
13
  modify_layout("#{tmp_dir}/layout/html/layout.erb")
@@ -1,3 +1,3 @@
1
1
  module MathJaxYard
2
- VERSION = "1.0.2"
2
+ VERSION = "1.0.3"
3
3
  end
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
11
11
 
12
12
  spec.summary = %q{mathjax-yard provides mathjax extention to yard.}
13
13
  spec.description = %q{mathjax-yard provides mathjax extention to yard.}
14
- spec.homepage = "https://github.com/daddygongon/mathjax-yard"
14
+ spec.homepage = "http://nishitani0.kwansei.ac.jp/Open/mathjax-yard"
15
15
  spec.license = "MIT"
16
16
 
17
17
  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -32,5 +32,6 @@ Gem::Specification.new do |spec|
32
32
  spec.add_development_dependency "rake", "~> 10.0"
33
33
  spec.add_development_dependency "rspec", "~> 3.0"
34
34
  spec.add_development_dependency "yard", "~> 0.8"
35
+ spec.add_development_dependency "hiki2md"
35
36
  spec.add_runtime_dependency "systemu"
36
37
  end
@@ -12,15 +12,16 @@ lib/../mathjax-yard.wiki/atom.mjx.md:
12
12
  $$f(\rho) =\sqrt{\rho}=\sqrt {\sum_j h^2 \left( r_j \right) }
13
13
  $$
14
14
  "$MATHJAX8$": "$\\rho$"
15
- "$MATHJAX9$": |-
15
+ "$MATHJAX9$": "$E_v$"
16
+ "$MATHJAX10$": |-
16
17
  $$E_v = -\frac{E_c}{2}\frac{2-poq}{1-poq}
17
18
  $$
18
19
  lib/../mathjax-yard.wiki/potential.mjx.md:
19
- "$MATHJAX10$": |-
20
+ "$MATHJAX11$": |-
20
21
  $$\begin{align*}
21
22
  dedr=-\frac{ n m d_0 \left(rh^{n}- rh^{m}\right) }{ \left(n-m \right) rr } \\
22
23
  E=\frac{ d_0 \left( r_0/rr^{n}m- r_0/rr^{m} n \right) }{ -n + m }
23
24
  \end{align*}
24
25
  $$
25
26
  lib/../mathjax-yard.wiki/Why_mathjax-yard.mjx.md:
26
- "$MATHJAX11$": "$LaTeX$"
27
+ "$MATHJAX12$": "$LaTeX$"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mathjax-yard
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Shigeto R. Nishitani
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2016-06-24 00:00:00.000000000 Z
11
+ date: 2016-08-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -66,6 +66,20 @@ dependencies:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0.8'
69
+ - !ruby/object:Gem::Dependency
70
+ name: hiki2md
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
69
83
  - !ruby/object:Gem::Dependency
70
84
  name: systemu
71
85
  requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ executables:
88
102
  extensions: []
89
103
  extra_rdoc_files: []
90
104
  files:
105
+ - ".#Rakefile"
91
106
  - ".gitignore"
92
107
  - ".rspec"
93
108
  - ".travis.yml"
@@ -101,11 +116,13 @@ files:
101
116
  - bin/setup
102
117
  - doc/MathJaxYard.html
103
118
  - doc/MathJaxYard/Command.html
119
+ - doc/Mathjax-yard_design_20160624.png
104
120
  - doc/_index.html
105
121
  - doc/class_list.html
106
122
  - doc/css/common.css
107
123
  - doc/css/full_list.css
108
124
  - doc/css/style.css
125
+ - doc/file.CODE_OF_CONDUCT.html
109
126
  - doc/file.Home.html
110
127
  - doc/file.README.html
111
128
  - doc/file.README_ja.html
@@ -113,6 +130,7 @@ files:
113
130
  - doc/file.Why_mathjax-yard.mjx.html
114
131
  - doc/file.atom.html
115
132
  - doc/file.atom.mjx.html
133
+ - doc/file.left_issue.html
116
134
  - doc/file.potential.html
117
135
  - doc/file.potential.mjx.html
118
136
  - doc/file_list.html
@@ -123,19 +141,21 @@ files:
123
141
  - doc/js/jquery.js
124
142
  - doc/method_list.html
125
143
  - doc/top-level-namespace.html
126
- - docs/README_ja.hiki
127
- - docs/Why_mathjax-yard.hiki
128
- - docs/atom.hiki
129
- - docs/potential.hiki
130
144
  - exe/mathjax-yard
145
+ - hikis/Mathjax-yard_design_20160624.pdf
146
+ - hikis/Mathjax-yard_design_20160624.png
147
+ - hikis/README_ja.hiki
148
+ - hikis/Why_mathjax-yard.hiki
149
+ - hikis/atom.hiki
150
+ - hikis/left_issue.hiki
151
+ - hikis/potential.hiki
131
152
  - lib/mathjax-yard.rb
132
153
  - lib/mathjax-yard/init.rb
133
154
  - lib/mathjax-yard/script.rb
134
155
  - lib/mathjax-yard/version.rb
135
156
  - mathjax-yard.gemspec
136
157
  - mathjax.yml
137
- - mathjax.yml.bk
138
- homepage: https://github.com/daddygongon/mathjax-yard
158
+ homepage: http://nishitani0.kwansei.ac.jp/Open/mathjax-yard
139
159
  licenses:
140
160
  - MIT
141
161
  metadata: {}
@@ -160,4 +180,3 @@ signing_key:
160
180
  specification_version: 4
161
181
  summary: mathjax-yard provides mathjax extention to yard.
162
182
  test_files: []
163
- has_rdoc:
@@ -1,28 +0,0 @@
1
- ---
2
- lib/../mathjax-yard.wiki/atom.md:
3
- "$MATHJAX1$": "$i$"
4
- "$MATHJAX2$": |-
5
- $$E_i = \sum_j\phi \left( r_j \right) + f(\rho)
6
- $$
7
- "$MATHJAX3$": "$r_j$"
8
- "$MATHJAX4$": "$j$"
9
- "$MATHJAX5$": "$E_i$"
10
- "$MATHJAX6$": "$i$"
11
- "$MATHJAX7$": |-
12
- $$f(\rho) =\sqrt{\rho}=\sqrt{\sum_j h^2 \left( r_j \right) }
13
- $$
14
- "$MATHJAX8$": "$\\rho$"
15
- "$MATHJAX9$": "$NPT$"
16
- "$MATHJAX10$": "$E-V$"
17
- "$MATHJAX11$": "$T=0.1$"
18
- "$MATHJAX12$": "$E_v$"
19
- "$MATHJAX13$": |-
20
- $$E_v = -\frac{E_c}{2} \frac{2-poq}{1-poq}
21
- $$
22
- "$MATHJAX14$": "$q$"
23
- lib/../mathjax-yard.wiki/potential2.md:
24
- "$MATHJAX15$": "$$ F(s)=\\int_{0}^{\\infty}f(t)e^{-st}dt $"
25
- "$MATHJAX16$": |-
26
- $$r_1=r/r_0 \\
27
- \frac{ d_0 \left( r_1^{-n}m- r_1^{-m} n \right) }{ -n + m }
28
- $$