@@ -72,13 +72,13 @@ $ Documentation/
72
72
73
73
#### swift-doc coverage
74
74
75
- The ` coverage ` subcommand
75
+ The ` coverage ` subcommand
76
76
generates documentation coverage statistics for Swift files.
77
77
78
78
``` terminal
79
79
$ git clone https://github.com/SwiftDocOrg/SwiftSemantics.git
80
80
81
- $ swift run swift-doc coverage SwiftSemantics/Sources/ --output "dcov.json"
81
+ $ swift run swift-doc coverage SwiftSemantics/Sources/ --output "dcov.json"
82
82
$ cat dcov.json | jq ".data.totals"
83
83
{
84
84
"count": 207,
@@ -145,14 +145,20 @@ are formatted for publication to your project's [GitHub Wiki][github wiki],
145
145
which you can do with
146
146
[ github-wiki-publish-action] [ github-wiki-publish-action ] .
147
147
Alternatively,
148
- you could publish ` swift-doc ` -generated documentation to GitHub Pages,
148
+ you could specify HTML format publish documentation to
149
+ [ GitHub Pages] ( https://pages.github.com )
149
150
or bundle them into a release artifact.
150
151
151
152
### Inputs
152
153
153
154
- ` inputs ` :
154
155
One or more paths to Swift files in your workspace.
155
156
(Default: ` "./Sources" ` )
157
+ - ` format ` :
158
+ The output format (` "commonmark" ` or ` "html" ` )
159
+ (Default: ` "commonmark" ` )
160
+ - ` module-name ` :
161
+ The name of the module.
156
162
- ` output ` :
157
163
The path for generated output.
158
164
(Default: ` "./.build/documentation" ` )
@@ -175,6 +181,7 @@ jobs:
175
181
uses : SwiftDocOrg/swift-doc@master
176
182
with :
177
183
inputs : " Source"
184
+ module-name : MyLibrary
178
185
output : " Documentation"
179
186
- name : Upload Documentation to Wiki
180
187
uses : SwiftDocOrg/github-wiki-publish-action@v1
193
200
Mattt ([@mattt](https://twitter.com/mattt))
194
201
195
202
[ci badge]: https://github.com/SwiftDocOrg/swift-doc/workflows/CI/badge.svg
196
-
197
203
[alamofire wiki]: https://github.com/SwiftDocOrg/Alamofire/wiki
198
204
[swiftsemantics html]: https://swift-doc-preview.netlify.app
199
205
[github wiki]: https://help.github.com/en/github/building-a-strong-community/about-wikis
0 commit comments