blob: 8570b9bbabf9597c79038e739c01674dfd2d6493 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<h2 id="dashzeal-docset-contributions"><a href="https://kapeli.com/dash">Dash</a>/<a href="https://zealdocs.org/">Zeal</a> Docset Contributions</h2>
<p>I package docsets for documentation generally unavailable through Dash/Zeal docsets.</p>
<p>My Dash docsets are based on a common <a href="https://github.com/lshprung/dash-docset-generation-template">generation template</a>. <br>Dash docsets maintained by me include:</p>
<table>
<thead>
<tr>
<th>Name (with link to generation upstream)</th>
<th>Documentation Source Upstream</th>
<th>Contributed to <a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master">Dash-User-Contributions</a>?</th>
<th>Relevant Debian Package</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://github.com/lshprung/debmake-dash-docset">debmake</a></td>
<td><a href="https://salsa.debian.org/debian/debmake">https://salsa.debian.org/debian/debmake</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/debmake">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/debmake-doc">debmake-doc</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/flex-dash-docset">flex</a></td>
<td><a href="https://github.com/westes/flex">https://github.com/westes/flex</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Flex">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/flex-doc">flex-doc</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-autoconf-dash-docset">GNU Autoconf</a></td>
<td><a href="https://www.gnu.org/software/autoconf/">https://www.gnu.org/software/autoconf/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Autoconf">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/autoconf-doc">autoconf-doc</a> !</td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-autoconf-archive-dash-docset">GNU Autoconf Archive</a></td>
<td><a href="https://www.gnu.org/software/autoconf-archive/">https://www.gnu.org/software/autoconf-archive/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Autoconf_Archive">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/autoconf-archive">autoconf-archive</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-automake-dash-docset">GNU Automake</a></td>
<td><a href="https://www.gnu.org/software/automake/">https://www.gnu.org/software/automake/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Automake">Yes</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-bash-dash-docset">GNU Bash</a></td>
<td><a href="https://www.gnu.org/software/bash/">https://www.gnu.org/software/bash/</a></td>
<td>No</td>
<td><a href="https://packages.debian.org/unstable/bash-doc">bash-doc</a> !</td>
</tr>
<tr>
<td>GNU Binutils [CONCEPT]</td>
<td><a href="https://www.gnu.org/software/binutils/">https://www.gnu.org/software/binutils/</a></td>
<td>No</td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-bison-dash-docset">GNU Bison</a> <strong>^</strong>3.8.2</td>
<td><a href="https://www.gnu.org/software/bison/">https://www.gnu.org/software/bison/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Bison">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/bison-doc">bison-doc</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-libc-dash-docset">GNU C Library (or "glibc")</a></td>
<td><a href="https://www.gnu.org/software/libc/libc.html">https://www.gnu.org/software/libc/libc.html</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/glibc">Yes</a></td>
<td><a href="https://packages.debian.org/sid/glibc-doc-reference">glibc-doc-reference</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-coding-standards-dash-docset">GNU Coding Standards</a> *</td>
<td><a href="https://savannah.gnu.org/projects/gnustandards">https://savannah.gnu.org/projects/gnustandards</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Coding_Standards">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/gnu-standards">gnu-standards</a> !</td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-coreutils-dash-docset">GNU Coreutils</a> [WIP]</td>
<td><a href="https://www.gnu.org/software/coreutils/">https://www.gnu.org/software/coreutils/</a></td>
<td>No</td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-grub-dash-docset">GNU Grub</a> (4 docsets) [WIP]</td>
<td><a href="https://www.gnu.org/software/grub/">https://www.gnu.org/software/grub/</a></td>
<td>No</td>
<td></td>
</tr>
<tr>
<td>GNU Guile 3+ (maintainer only)</td>
<td><a href="https://www.gnu.org/software/guile/">https://www.gnu.org/software/guile/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Guile">Yes</a></td>
<td></td>
</tr>
<tr>
<td>GNU Guix [CONCEPT]</td>
<td><a href="https://guix.gnu.org/">https://guix.gnu.org/</a></td>
<td>No</td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-libtool-dash-docset">GNU Libtool</a> *</td>
<td><a href="https://www.gnu.org/software/libtool/">https://www.gnu.org/software/libtool/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Libtool">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/libtool-doc">libtool-doc</a> !</td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-make-dash-docset">GNU Make</a></td>
<td><a href="https://www.gnu.org/software/make/">https://www.gnu.org/software/make/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Make">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/make-doc">make-doc</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/gnu-texinfo-dash-docset">GNU Texinfo</a> (2 docsets) [WIP]</td>
<td><a href="https://www.gnu.org/software/texinfo/">https://www.gnu.org/software/texinfo/</a></td>
<td>No</td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/meson-dash-docset">Meson</a></td>
<td><a href="https://mesonbuild.com/index.html">https://mesonbuild.com/index.html</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Meson">Yes</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/ncurses-dash-docset">ncurses</a></td>
<td><a href="https://invisible-island.net/ncurses/">https://invisible-island.net/ncurses/</a></td>
<td><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/ncurses">Yes</a></td>
<td><a href="https://packages.debian.org/unstable/ncurses-doc">ncurses-doc</a></td>
</tr>
<tr>
<td><a href="https://github.com/lshprung/nsis-dash-docset">NSIS</a> [WIP]</td>
<td><a href="https://nsis.sourceforge.io/">https://nsis.sourceforge.io/</a></td>
<td>No</td>
<td><a href="https://packages.debian.org/unstable/nsis-doc">nsis-doc</a></td>
</tr>
</tbody></table>
<p>'*' indicates that the docset creation script could use improvement, usually in indexing index entries <br>'<strong>^</strong>' indicates that a new version needs to be packaged, uploaded to the releases tab of the repo, and pushed to Dash-User-Contributions <br>'!' indicates that the files this package ships do not match what the generation script expects (i.e., documentation is shipped as a single HTML file, as opposed to one HTML file for each node)</p>
<p>Some docsets I do not intend to contribute to <a href="https://github.com/Kapeli/Dash-User-Contributions">Dash-User-Contributions</a>, usually because my docset diverges from one that was already contributed or there is already an official version of the docset:</p>
<p>Some docsets are marked "[WIP]". This indicates that some working model exists, but has not yet been successfully pushed to Dash-User-Contributions.</p>
<p>Some docsets marked as "[CONCEPT]". This indicates that I have desire to package in the future include.</p>
<hr>
<h4 id="regarding-gnu-project-docsets">Regarding GNU project docsets</h4>
<p>It has been tiring to manage the high redundancy of the code in my various docset generation repos. This is especially true among GNU project docsets, and I believe it would be beneficial to contain all of these in a single repo. A few things to note:</p>
<ol>
<li>I would have to find a different solution to uploading compiled docsets, since I currently use the "releases" page of each repo.</li>
<li>There are certain edge cases in certain repos that may make things annoying. I would either have to account for these on a case by case basis or build a better infrastructure.</li>
</ol>
<p>For now, this remains an idea that I will need to brainstorm further...</p>
|
