Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit 67336a0

Browse files
authored
Merge branch 'master' into html
2 parents 3fc0d1f + b5274fb commit 67336a0

File tree

5 files changed

+13
-52
lines changed

5 files changed

+13
-52
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM swift:5.1 as builder
1+
FROM swift:5.2 as builder
22
WORKDIR /swiftdoc
33
COPY . .
44
RUN mkdir -p /build/lib && cp -R /usr/lib/swift/linux/*.so* /build/lib

Package.resolved

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Package.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ let package = Package(
1010
.library(name: "SwiftDoc", targets: ["SwiftDoc"])
1111
],
1212
dependencies: [
13-
.package(url: "https://github.com/apple/swift-syntax.git", .revision("swift-5.2-DEVELOPMENT-SNAPSHOT-2020-03-09-a")),
14-
.package(url: "https://github.com/SwiftDocOrg/SwiftSemantics.git", .branch("swift-5.2")),
13+
.package(url: "https://github.com/apple/swift-syntax.git", .revision("0.50200.0")),
14+
.package(url: "https://github.com/SwiftDocOrg/SwiftSemantics.git", .upToNextMinor(from: "0.1.0")),
1515
.package(url: "https://github.com/SwiftDocOrg/CommonMark.git", .branch("master")),
1616
.package(url: "https://github.com/SwiftDocOrg/SwiftMarkup.git", .upToNextMinor(from: "0.0.5")),
1717
.package(url: "https://github.com/SwiftDocOrg/GraphViz.git", .revision("03405c13dc1c31f50c08bbec6e7587cbee1c7fb3")),

README.md

Lines changed: 6 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ For an example of generated documentation,
1919
> Output is currently limited to CommonMark,
2020
> but the plan is to support HTML and other formats as well.
2121
22+
## Requirements
23+
24+
- Swift 5.2
25+
2226
## Command-Line Utility
2327

2428
`swift-doc` can be used from the command-line on macOS and Linux.
@@ -50,7 +54,7 @@ collecting all Swift files into a single "module"
5054
and generating documentation accordingly.
5155

5256
```terminal
53-
$ swift doc path/to/SwiftProject/Sources --output Documentation
57+
$ swift doc generate path/to/SwiftProject/Sources --output Documentation
5458
$ tree Documentation
5559
$ Documentation/
5660
├── Home
@@ -170,7 +174,7 @@ jobs:
170174
inputs: "Source"
171175
output: "Documentation"
172176
- name: Upload Documentation to Wiki
173-
uses: SwiftDocOrg/github-wiki-publish-action@master
177+
uses: SwiftDocOrg/github-wiki-publish-action@v1
174178
with:
175179
path: "Documentation"
176180
env:
@@ -282,48 +286,6 @@ generating HTML, CSS, and a search index instead of just text.
282286
Compare its [generated HTML output][jazzy swiftsemantics]
283287
to [a GitHub wiki generated with `swift-doc`][swift-doc swiftsemantics].
284288

285-
## What About [SwiftDoc.org][swiftdoc.org]?
286-
287-
**tl;dr:**
288-
SwiftDoc.org is now updated for Swift 5.1,
289-
but we're still working to migrate over a few missing parts
290-
(notably, the beloved
291-
[type inheritance graphs](https://swiftdoc.org/v4.2/protocol/expressiblebyfloatliteral/hierarchy/)).
292-
293-
SwiftDoc.org,
294-
[originally "Swifter"](http://natecook.com/blog/2014/09/introducing-swifter/),
295-
was created by Nate Cook ([@natecook1000][@natecook1000])
296-
in September 2014.
297-
At the time,
298-
Swift tooling was still in its infancy,
299-
so Nate actually
300-
[wrote a parser (from scratch!)](https://github.com/SwiftDocOrg/swiftdoc-parser)
301-
to pull symbols and documentation from the Swift standard library.
302-
Nate became managing editor of [NSHipster][nshipster] in 2015,
303-
bringing SwiftDoc with him as an affiliated project.
304-
When Mattt took over NSHipster duties for Nate in 2018,
305-
he inherited SwiftDoc along with it.
306-
307-
After the hand-off,
308-
we were able to get the site updated for Swift 4.2 without too much trouble.
309-
But when it came time to regenerate the site for Swift 5,
310-
we found ourselves deep in ["dependency hell"][dependency hell]
311-
(something to do with the [regular expression][pcre] library
312-
that Nate had used for the parser).
313-
After begging and pleading with
314-
the spirits possessing our `node_modules` directory to no avail,
315-
we decided to roll up our sleeves and get started on a long-term replacement —
316-
this time, written in Swift.
317-
318-
_Thanks for all of your encouragement about the site over the years
319-
and your patience throughout this whole process.
320-
We're sorry it took so long to get around to getting it updated,
321-
but we hope this all will have been worth the wait!_ 🙇‍♂️
322-
323-
## Project Roadmap
324-
325-
_(Coming soon!)_
326-
327289
## License
328290

329291
MIT

Sources/SwiftDoc/Module.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,4 @@ public final class Module: Codable {
4040

4141
self.init(name: name, sourceFiles: sourceFiles)
4242
}
43-
4443
}

0 commit comments

Comments
 (0)