rdoc-generator-sixfish 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data/History.md +9 -0
  4. data/README.md +84 -0
  5. data/data/rdoc-generator-sixfish/css/fa-solid-900.515704be.ttf +0 -0
  6. data/data/rdoc-generator-sixfish/css/fa-solid-900.7ba04835.svg +1 -0
  7. data/data/rdoc-generator-sixfish/css/fa-solid-900.8c589fd1.eot +0 -0
  8. data/data/rdoc-generator-sixfish/css/fa-solid-900.c7b072c6.woff +0 -0
  9. data/data/rdoc-generator-sixfish/css/fa-solid-900.f2049a98.woff2 +0 -0
  10. data/data/rdoc-generator-sixfish/css/sixfish.css +2 -0
  11. data/data/rdoc-generator-sixfish/css/sixfish.css.map +1 -0
  12. data/data/rdoc-generator-sixfish/js/sixfish.js +39 -0
  13. data/data/rdoc-generator-sixfish/js/sixfish.js.map +1 -0
  14. data/data/rdoc-generator-sixfish/templates/class.tmpl +211 -0
  15. data/data/rdoc-generator-sixfish/templates/file.tmpl +8 -0
  16. data/data/rdoc-generator-sixfish/templates/index.tmpl +83 -0
  17. data/data/rdoc-generator-sixfish/templates/layout.tmpl +97 -0
  18. data/lib/inversion/template/striptag.rb +42 -0
  19. data/lib/rdoc/discover.rb +7 -0
  20. data/lib/rdoc/generator/sixfish.rb +413 -0
  21. data/lib/sixfish/patches.rb +73 -0
  22. data/lib/sixfish.rb +31 -0
  23. data/spec/helpers.rb +45 -0
  24. data/spec/rdoc/generator/sixfish_spec.rb +256 -0
  25. data/spec/sixfish_spec.rb +19 -0
  26. data.tar.gz.sig +0 -0
  27. metadata +165 -0
  28. metadata.gz.sig +0 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7f65a068f3ec7d7360f6c477760d22fcac70bb83f675e589cb2b47f1e6ad0566
4
+ data.tar.gz: 4572bee86d8f5d18d309514249fc2857bccff0079fc2e280026a953ff22b36d1
5
+ SHA512:
6
+ metadata.gz: 6ad068aa5c4f937ee7c044154839d9528ce76575657eb11f6ced8405436517a3dd8955c1f8d6b3a3e95bb5fc5367b383a8edb23caf4f75cc5f9c893bf6e53ac4
7
+ data.tar.gz: 6a27027c87c715757ccb4b0d15aeb53f8d3c1df58f661e7a587e170e88d3af8601eb55ad3a819ab3bf0a764d7105abd6085435adb90514c29f5c6bf6b7c0f89b
checksums.yaml.gz.sig ADDED
Binary file
data/History.md ADDED
@@ -0,0 +1,9 @@
1
+ # Release History for rdoc-generator-sixfish
2
+
3
+ ---
4
+
5
+
6
+ ## v0.1.0 [2022-11-15] Michael Granger <ged@FaerieMUD.org>
7
+
8
+ Initial release.
9
+
data/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # Sixfish RDoc
2
+
3
+ home
4
+ : https://hg.sr.ht/~ged/Sixfish
5
+
6
+ code
7
+ : https://hg.sr.ht/~ged/Sixfish
8
+
9
+ github
10
+ : https://github.com/ged/sixfish
11
+
12
+ docs
13
+ : https://deveiate.org/code/sixfish
14
+
15
+
16
+
17
+ ## Description
18
+
19
+ A readable HTML generator for RDoc. It uses the [Bulma](https://bulma.io/) CSS framework.
20
+
21
+
22
+ ## Installation
23
+
24
+ gem install rdoc-generator-sixfish
25
+
26
+
27
+ ## Usage
28
+
29
+ rdoc --format=sixfish
30
+
31
+
32
+ ## Contributing
33
+
34
+ You'll need [Yarn](https://yarnpkg.com/) to build this gem.
35
+
36
+ You can check out the current development source [with Mercurial](https://hg.sr.ht/~ged/Sixfish)], or if you prefer Git, via the project's [Github mirror](https://github.com/ged/sixfish).
37
+
38
+ After checking out the source and changing into the new directory, run:
39
+
40
+ $ gem install -Ng
41
+ $ rake setup
42
+
43
+ This task will install dependencies, and do any necessary development setup.
44
+
45
+
46
+ ## Authors
47
+
48
+ - Michael Granger <ged@faeriemud.org>
49
+
50
+
51
+ ## License
52
+
53
+ This uses the Bulma CSS Framework, and a licensed version of Font Awesome Pro 5.
54
+
55
+ Sixfish itself is:
56
+
57
+ Copyright © 2015-2022, Michael Granger
58
+ All rights reserved.
59
+
60
+ Redistribution and use in source and binary forms, with or without
61
+ modification, are permitted provided that the following conditions are met:
62
+
63
+ * Redistributions of source code must retain the above copyright notice,
64
+ this list of conditions and the following disclaimer.
65
+
66
+ * Redistributions in binary form must reproduce the above copyright notice,
67
+ this list of conditions and the following disclaimer in the documentation
68
+ and/or other materials provided with the distribution.
69
+
70
+ * Neither the name of the author/s, nor the names of the project's
71
+ contributors may be used to endorse or promote products derived from this
72
+ software without specific prior written permission.
73
+
74
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
75
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
76
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
77
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
78
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
79
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
80
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
81
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
82
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
83
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
84
+