Skip to content

Commit 8df2f65

Browse files
Diggoryd-ronnqvist
andauthored
Added information on how to create a Documentation Catalogue. (#1165)
* Added information on how to create a Documentation Catalogue. * US spelling... * Missing quote marks in image references. * Update Sources/docc/DocCDocumentation.docc/documenting-a-swift-framework-or-package.md Co-authored-by: David Rönnqvist <[email protected]> * Undo changes to image references. * Explanations of what a catalogue is in filesystem terms. --------- Co-authored-by: David Rönnqvist <[email protected]>
1 parent bda4ac9 commit 8df2f65

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Sources/docc/DocCDocumentation.docc/adding-supplemental-content-to-a-documentation-catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Include articles and extension files to extend your source documentation comment
44

55
## Overview
66

7-
A documentation catalog contains files that enrich your source documentation
7+
A documentation catalog (a directory with a '.docc' extension) contains files that enrich your source documentation
88
comments. Two types of files that documentation catalogs can contain are
99
articles and extension files.
1010

Sources/docc/DocCDocumentation.docc/documenting-a-swift-framework-or-package.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ By default, DocC compiles only in-source symbol documentation and then
4747
groups those symbols together by their kind, such as protocols, classes,
4848
enumerations, and so forth. When you want to provide additional content or
4949
customize the organization of symbols, use a documentation
50-
catalog.
50+
catalog (a directory with a '.docc' extension).
5151

5252
DocC combines the public API information from the Swift compiler with the
5353
contents of the documentation catalog to generate a much richer DocC Archive.
@@ -71,6 +71,8 @@ step-by-step, interactive content. For more information, see
7171
> Important: To use a documentation catalog in a Swift package, make sure the
7272
manifest's Swift tools version is set to `5.5` or later.
7373

74+
To associate a documentation catalog with a target in your package, add the catalog to the same directory as the target's other source files (`[PackageRoot]/Sources/[TargetName]` by default).
75+
7476
## Building, Publishing, and Previewing Documentation with the DocC Plug-in
7577

7678
The preferred way of building documentation for your Swift package is by using

0 commit comments

Comments
 (0)