You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
html2Dash is an Documentation Set generator intended to be used with the [Dash.app](http://kapeli.com/dash/) API browser for OS X or one of its many clones. html2Dash is just like [doc2dash](https://github.com/hynek/doc2dash) but generating docset from any HTML documentations.
4
84
5
85
If you’ve never heard of Dash.app, you’re missing out: together with html2Dash it’s all your API documentation at your fingertips!
6
86
7
87
Third part library required:
8
-
88
+
9
89
beautifulsoup4==4.3.2
10
90
11
91
It’s tested on Python 2.7, OS X 10.9.
@@ -22,46 +102,46 @@ html2dash will create a new directory called `<htmldir>.docset` in `~/Library/Ap
22
102
23
103
The full usage is:
24
104
25
-
$ doc2dash [OPTIONS] SOURCE
105
+
$ doc2dash [OPTIONS] SOURCE
26
106
27
107
The `SOURCE` is a directory containing the HTML documents you would like to convert.
28
108
29
109
Valid `OPTIONS` are the following:
30
110
31
-
* -n, --name
111
+
* -n, --name
32
112
33
113
Name the docset explicitly instead of letting doc2dash guess the correct name from the directory name of the source.
34
114
35
-
* -d PATH, --destination PATH
115
+
* -d PATH, --destination PATH
36
116
37
-
Put the resulting docset into PATH. Default is the directory `~/Library/Application Support/html2dash/DocSets`
117
+
Put the resulting docset into PATH. Default is the directory `~/Library/Application Support/html2dash/DocSets`
38
118
39
119
* -i FILENAME, --icon FILENAME
40
120
41
121
Add PNG icon FILENAME to docset that is used within Dash.app to represent the docset.
42
-
122
+
43
123
* -p INDEX_PAGE, --index-page INDEX_PAGE
44
-
124
+
45
125
Set the file that is shown when the docset is clicked within Dash.app.
46
-
126
+
47
127
* -h, --help
48
128
49
129
Show a brief usage summary and exit.
50
130
51
-
DEPENDENCIES:
52
-
131
+
DEPENDENCIES:
132
+
53
133
* BeautifulSoup HTML parsing library
54
134
55
135
# Demo
56
136
57
137
Generate the Docset for requests: `requests.docset`. Command:
0 commit comments