Skip to content

Commit 23eae08

Browse files
committed
docs: add artifact path functions to API reference
- Add purl_spec_path, type_definitions_path, test_fixtures_path to docs - Add Pkg dependency to docs/Project.toml for PURL's Pkg.Artifacts usage
1 parent 171dba1 commit 23eae08

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
34
PURL = "c2271b70-7219-4bda-bcc3-62ec08ead5b7"
45

56
[compat]

docs/src/api.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ PURLError
1919
@purl_str
2020
```
2121

22+
## Bundled Artifact Paths
23+
24+
Functions to access the bundled purl-spec v1.0.0 artifact containing official type definitions and test fixtures.
25+
26+
```@docs
27+
purl_spec_path
28+
type_definitions_path
29+
test_fixtures_path
30+
```
31+
2232
## Type Definitions
2333

2434
Types and functions for loading and registering custom type definitions from JSON.

0 commit comments

Comments
 (0)