Skip to content

Commit 4b2954c

Browse files
authored
documentation update to clarify CLI option (#491)
* documentation update to clarify CLI option - related to #490, updates the documentation to identify that --checkout-path requires an absolute oath, not a relative path. * Update Sources/docc/DocCDocumentation.docc/distributing-documentation-to-other-developers.md
1 parent e1e3a97 commit 4b2954c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Sources/docc/DocCDocumentation.docc/distributing-documentation-to-other-developers.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,28 @@ service configuration flags like so:
6161
docc convert […] \
6262
--source-service github \
6363
--source-service-base-url https://github.com/<org>/<repo>/blob/<branch> \
64-
--checkout-path <path to local checkout>
64+
--checkout-path <absolute path to local checkout>
6565
```
6666

6767
**GitLab**
6868
```bash
6969
docc convert […] \
7070
--source-service gitlab \
7171
--source-service-base-url https://gitlab.com/<org>/<repo>/-/tree/<branch> \
72-
--checkout-path <path to local checkout>
72+
--checkout-path <absolute path to local checkout>
7373
```
7474

7575
**BitBucket**
7676
```bash
7777
docc convert […] \
7878
--source-service bitbucket \
7979
--source-service-base-url https://bitbucket.org/<org>/<repo>/src/<branch> \
80-
--checkout-path <path to local checkout>
80+
--checkout-path <absolute path to local checkout>
8181
```
8282

83+
> Note: The option `--checkout-path` expects an absolute path to where the package
84+
is checked out, not a relative path.
85+
8386
These arguments can also be provided to `swift package generate-documentation`
8487
if you're using the SwiftPM DocC Plugin or via the `OTHER_DOCC_FLAGS` build
8588
setting when building in Xcode.

0 commit comments

Comments
 (0)