Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cuvs/fern/build_docs.sh at main · NVIDIA/cuvs · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
NVIDIA
/
cuvs
Public
Notifications
You must be signed in to change notification settings
Fork
231
Star
847
Code
Issues
579
Pull requests
137
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
cuvs
/
fern
/
build_docs.sh
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
executable file
·
126 lines (108 loc) · 2.94 KB
main
Breadcrumbs
cuvs
/
fern
/
build_docs.sh
Copy path
Top
File metadata and controls
Code
Blame
executable file
·
126 lines (108 loc) · 2.94 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
#!
/bin/bash
#
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION.
#
SPDX-License-Identifier: Apache-2.0
set
-euo pipefail
SCRIPT_DIR=
$(
cd
"
$(
dirname
"
${BASH_SOURCE[0]}
"
)
"
&&
pwd
)
REPO_DIR=
$(
cd
"
${SCRIPT_DIR}
/..
"
&&
pwd
)
MODE=
"
${1
:-
check}
"
if
[[
$#
-gt
0 ]]
;
then
shift
fi
usage
() {
cat
<<
'
EOF
'
Usage: fern/build_docs.sh [check|preview|publish|dev] [fern arguments...]
Modes:
check Validate Fern configuration, links, and Markdown syntax.
preview Build and publish a Fern preview deployment.
publish Build and publish the production Fern docs site.
dev Start Fern's local docs preview server.
Examples:
fern/build_docs.sh
fern/build_docs.sh preview --id pr-123 --force
fern/build_docs.sh publish --instance rapids-cuvs.docs.buildwithfern.com
fern/build_docs.sh dev --port 3002
EOF
}
require_node_22
() {
if
!
command
-v node
>
/dev/null
2>&1
;
then
echo
"
Fern docs require Node.js 22 or newer, but node was not found on PATH.
"
>&2
echo
"
Install or activate Node.js 22+ before running fern/build_docs.sh.
"
>&2
exit
1
fi
local
node_version
local
node_major
node_version=
$(
node -p
'
process.versions.node
'
2>
/dev/null
||
true
)
node_major=
"
${node_version
%%
.
*
}
"
if
[[
!
"
${node_major}
"
=~
^[0-9]+$
||
"
${node_major}
"
-lt
22 ]]
;
then
echo
"
Fern docs require Node.js 22 or newer, but found Node.js
${node_version
:-
unknown}
.
"
>&2
echo
"
Older Node.js versions can fail with errors such as
\"
SyntaxError: Unexpected token '.'.
\"
"
>&2
echo
"
Install or activate Node.js 22+ before running fern/build_docs.sh.
"
>&2
exit
1
fi
}
require_node_22
fern_config_version
() {
python3 -
"
${SCRIPT_DIR}
/fern.config.json
"
<<
'
PY
'
import json
import sys
with open(sys.argv[1], encoding="utf-8") as f:
print(json.load(f).get("version", "*"))
PY
}
FERN_VERSION=
"
$(
fern_config_version
)
"
if
[[
-n
"
${FERN_CLI
:-
}
"
]]
;
then
FERN_CMD=(
"
${FERN_CLI}
"
)
elif
[[
"
${FERN_VERSION}
"
!=
"
*
"
]]
;
then
FERN_CMD=(
"
npx
"
"
--yes
"
"
fern-api@
${FERN_VERSION}
"
)
elif
command
-v fern
>
/dev/null
2>&1
;
then
FERN_CMD=(
"
fern
"
)
else
FERN_CMD=(
"
npx
"
"
--yes
"
"
fern-api
"
)
fi
run_fern
() {
"
${FERN_CMD[@]}
"
"
$@
"
}
generate_api_reference
() {
python3
"
${SCRIPT_DIR}
/scripts/generate_api_reference.py
"
}
run_checks
() {
pushd
"
${REPO_DIR}
"
>
/dev/null
run_fern check --warnings
run_fern docs md check
popd
>
/dev/null
}
case
"
${MODE}
"
in
check)
generate_api_reference
run_checks
;;
preview)
generate_api_reference
run_checks
pushd
"
${REPO_DIR}
"
>
/dev/null
run_fern generate --docs --preview
"
$@
"
popd
>
/dev/null
;;
publish)
generate_api_reference
run_checks
pushd
"
${REPO_DIR}
"
>
/dev/null
run_fern generate --docs
"
$@
"
popd
>
/dev/null
;;
dev)
generate_api_reference
pushd
"
${REPO_DIR}
"
>
/dev/null
run_fern docs dev
"
$@
"
popd
>
/dev/null
;;
-h|--help|help)
usage
;;
*
)
echo
"
Unknown mode:
${MODE}
"
>&2
echo
>&2
usage
>&2
exit
2
;;
esac
You can’t perform that action at this time.