astzweig/swift-inotify
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README section about docs generation
Some checks failed
Docs / docs (push) Has been cancelled
Details
Docs / deploy (push) Has been cancelled
Details

Browse Source 
Show how to generate the Docc docs using task CLI instead of faning out
to swift package docc plugin.
This commit is contained in:
T. R. Bernstein
2026-03-13 02:32:15 +01:00
parent 672c4b85f2
commit 29e35ae386
1 changed files with 3 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -123,18 +123,15 @@ Use `-v`, `-vv`, or `-vvv` to increase log verbosity. The command runs two passe
Docker must be installed and running on your machine. Docker must be installed and running on your machine.
## Documentation ### Documentation
Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with: Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with:
```bash ```bash
# Inotify library swift run task generate-docs
swift package generate-documentation --target Inotify
# Task build tool
swift package generate-documentation --target TaskCLI
``` ```
Then open the files in the newly created `public` folder.
Or preview in Xcode by selecting **Product > Build Documentation**. Or preview in Xcode by selecting **Product > Build Documentation**.
## Requirements ## Requirements