Skip to content

Commit 13c56f4

Browse files
bentshermanbentsherman
authored
docs: split stdlib docs into separate pages
Signed-off-by: Ben Sherman <bentshermann@gmail.com> Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
1 parent 1bb78e2 commit 13c56f4

47 files changed

Lines changed: 1927 additions & 1677 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.docusaurus_site/sidebars.js‎

Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ module.exports = {
3333
"working-with-files",
3434
"process",
3535
"workflow",
36+
{
37+
type: "category",
38+
label: "Static typing",
39+
collapsed: true,
40+
link: { type: "doc", id: "static-typing" },
41+
items: [
42+
"process-typed",
43+
"workflow-typed",
44+
"typed-parameters"
45+
]
46+
},
3647
"notifications",
3748
"secrets",
3849
"sharing",
@@ -50,17 +61,6 @@ module.exports = {
5061
"modules/module-registry"
5162
]
5263
},
53-
{
54-
type: "category",
55-
label: "Static typing",
56-
collapsed: true,
57-
link: { type: "doc", id: "static-typing" },
58-
items: [
59-
"process-typed",
60-
"workflow-typed",
61-
"typed-parameters"
62-
]
63-
},
6464
{
6565
type: "category",
6666
label: "Software dependencies",
@@ -110,8 +110,42 @@ module.exports = {
110110
label: "Standard library",
111111
link: { type: "doc", id: "reference/stdlib" },
112112
items: [
113-
"reference/stdlib-namespaces",
114-
"reference/stdlib-types",
113+
{
114+
type: "category",
115+
label: "Namespaces",
116+
link: { type: "doc", id: "reference/stdlib-namespaces" },
117+
items: [
118+
"reference/stdlib-namespaces/global",
119+
"reference/stdlib-namespaces/channel",
120+
"reference/stdlib-namespaces/log",
121+
"reference/stdlib-namespaces/nextflow",
122+
"reference/stdlib-namespaces/workflow"
123+
]
124+
},
125+
{
126+
type: "category",
127+
label: "Types",
128+
link: { type: "doc", id: "reference/stdlib-types" },
129+
items: [
130+
"reference/stdlib-types/bag",
131+
"reference/stdlib-types/boolean",
132+
"reference/stdlib-types/channel",
133+
"reference/stdlib-types/duration",
134+
"reference/stdlib-types/float",
135+
"reference/stdlib-types/integer",
136+
"reference/stdlib-types/iterable",
137+
"reference/stdlib-types/list",
138+
"reference/stdlib-types/map",
139+
"reference/stdlib-types/memory-unit",
140+
"reference/stdlib-types/path",
141+
"reference/stdlib-types/record",
142+
"reference/stdlib-types/set",
143+
"reference/stdlib-types/string",
144+
"reference/stdlib-types/tuple",
145+
"reference/stdlib-types/value",
146+
"reference/stdlib-types/version-number"
147+
]
148+
},
115149
"reference/stdlib-groovy"
116150
]
117151
},

‎.docusaurus_site/src/custom.css‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@ h5, h6 {
1717
width: 100%;
1818
}
1919

20+
/* Sidebar indentation beyond level 2.
21+
Each nested `menu__list` lives inside its parent `li`, so these margins
22+
compound down the tree — every level needs the same 1rem step, not a larger
23+
absolute value. Links already get 1rem at every level from the theme's `ml-4`;
24+
the theme only indents categories up to level 2, so level-3+ categories sit
25+
flush with their parent. Match them to the level-2 step so deeper branches
26+
(e.g. Language reference > Standard library > Namespaces) nest visually. */
27+
.theme-doc-sidebar-item-category-level-3.menu__list-item,
28+
.theme-doc-sidebar-item-category-level-4.menu__list-item,
29+
.theme-doc-sidebar-item-category-level-5.menu__list-item {
30+
margin-left: 1rem;
31+
}
32+
2033
/* Make wide tables horizontally scrollable instead of overflowing the page */
2134
.markdown table {
2235
display: block;

‎docs/amazons3.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,5 +103,5 @@ See [AWS configuration][config-aws] for more information about advanced S3 clien
103103

104104

105105
[config-aws]: ./reference/config#aws
106-
[stdlib-types-path]: ./reference/stdlib-types#path
106+
[stdlib-types-path]: ./reference/stdlib-types/path
107107
[working-with-files]: ./working-with-files

‎docs/cache-and-resume.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,6 @@ Nextflow now has a built-in way to compare two task runs. See the [Data lineage]
252252
[process-script]: ./process#script
253253
[process-spack]: ./reference/process#spack
254254
[process-stub]: ./process#stub
255-
[stdlib-namespaces-workflow]: ./reference/stdlib-namespaces
255+
[stdlib-namespaces-workflow]: ./reference/stdlib-namespaces/workflow
256256
[strict-syntax-page]: ./strict-syntax
257257
[trace-report]: ./reports#trace-file

‎docs/developer/nextflow.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ The `Session` class is the top-level representation of a Nextflow run, or "sessi
4444

4545
[channel-factory]: ../reference/channel
4646
[nextflow-script]: ./nextflow.script
47-
[stdlib-namespaces-global]: ../reference/stdlib-namespaces#global-namespace
47+
[stdlib-namespaces-global]: ../reference/stdlib-namespaces/global

‎docs/migrations/26-04.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ A Platform access token with appropriate permissions is required to download non
440440
[process-typed-page]: ../process-typed
441441
[script-records]: ../script#records
442442
[static-typing-first-preview]: ./25-10#static-typing-preview
443-
[stdlib-listDirectory]: ../reference/stdlib-types#listdirectory---iterablepath
443+
[stdlib-listDirectory]: ../reference/stdlib-types/path#listdirectory---iterablepath
444444
[strict-syntax-page]: ../strict-syntax
445445
[workflow-typed-page]: ../workflow-typed
446446
[workflow-typed-params]: ../typed-parameters

‎docs/process.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1353,7 +1353,7 @@ process hello {
13531353
[script-closure]: ./script#closures
13541354
[script-tuples]: ./script#tuples
13551355
[static-typing-page]: ./static-typing
1356-
[stdlib-types-path]: ./reference/stdlib-types#path
1356+
[stdlib-types-path]: ./reference/stdlib-types/path
13571357
[strict-syntax-page]: ./strict-syntax
13581358
[string-interpolation]: ./script#string-interpolation
13591359
[syntax-function]: ./reference/syntax#function

‎docs/reference/config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2631,7 +2631,7 @@ workflow.output.tags = [FOO'hello', BAR'world']
26312631
[seqera-executor]: ../executor#seqera
26322632
[sharing-page]: ../sharing
26332633
[slurm-executor]: ../executor#slurm
2634-
[stdlib-types-versionnumber]: ./stdlib-types#versionnumber
2634+
[stdlib-types-versionnumber]: ./stdlib-types/version-number
26352635
[timeline-report]: ../reports#execution-timeline
26362636
[trace-report]: ../reports#trace-file
26372637
[wave-page]: ../wave

‎docs/reference/process.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,9 +1831,9 @@ See also: [cpus](#cpus), [disk](#disk), [memory](#memory), [queue](#queue), [dyn
18311831
[sge-executor]: ../executor#sge
18321832
[slurm-executor]: ../executor#slurm
18331833
[spack-page]: ../spack
1834-
[stdlib-namespaces-workflow]: ./stdlib-namespaces#workflow
1835-
[stdlib-types-duration]: ./stdlib-types#duration
1836-
[stdlib-types-memoryunit]: ./stdlib-types#memoryunit
1834+
[stdlib-namespaces-workflow]: ./stdlib-namespaces/workflow
1835+
[stdlib-types-duration]: ./stdlib-types/duration
1836+
[stdlib-types-memoryunit]: ./stdlib-types/memory-unit
18371837
[task-directive-values]: ../process#using-task-directive-values
18381838
[trace-report]: ../reports#trace-file
18391839
[tracing-page]: ../reports

‎docs/reference/semantics.mdx‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The *semantics* of the Nextflow language are the meaning and behavior of each la
99

1010
## Values
1111

12-
Every expression in Nextflow produces a *value*, and every value has a [type](#types) that determines the operations it supports. This section describes the kinds of values in the language and how they behave. See the [Types][stdlib-types] reference for the full set of operations available on each type, and [Syntax][syntax-page] for the grammar of each literal.
12+
Every expression in Nextflow produces a *value*, and every value has a [type](#types) that determines the operations it supports. This section describes the kinds of values in the language and how they behave. Each kind of value links to its type reference, which describes the full set of available operations. See [Syntax][syntax-page] for the grammar of each literal.
1313

1414
### Booleans
1515

@@ -901,7 +901,7 @@ The entry workflow of an included script is ignored. This allows the same script
901901

902902
## Types
903903

904-
Every value in Nextflow has a *type*, which determines the set of operations that can be performed on it. The available types are described in the [Types][stdlib-types] reference.
904+
Every value in Nextflow has a *type*, which determines the set of operations that can be performed on it. The available types are described in [Values](#values).
905905

906906
Nextflow supports two styles of typing:
907907

@@ -1029,18 +1029,17 @@ A value is also cast *implicitly* in the following situations:
10291029
[process-error-strategy]: ./process#errorstrategy
10301030
[process-page]: ../process
10311031
[script-page]: ../script
1032-
[stdlib-error]: ./stdlib-namespaces
1033-
[stdlib-types]: ./stdlib-types
1034-
[stdlib-types-float]: ./stdlib-types#float
1035-
[stdlib-types-integer]: ./stdlib-types#integer
1036-
[stdlib-types-iterable]: ./stdlib-types#iterablee
1037-
[stdlib-types-bag]: ./stdlib-types#bage
1038-
[stdlib-types-list]: ./stdlib-types#liste
1039-
[stdlib-types-map]: ./stdlib-types#mapkv
1040-
[stdlib-types-record]: ./stdlib-types#record
1041-
[stdlib-types-set]: ./stdlib-types#sete
1042-
[stdlib-types-string]: ./stdlib-types#string
1043-
[stdlib-types-tuple]: ./stdlib-types#tuple
1032+
[stdlib-error]: ./stdlib-namespaces/global
1033+
[stdlib-types-float]: ./stdlib-types/float
1034+
[stdlib-types-integer]: ./stdlib-types/integer
1035+
[stdlib-types-iterable]: ./stdlib-types/iterable
1036+
[stdlib-types-bag]: ./stdlib-types/bag
1037+
[stdlib-types-list]: ./stdlib-types/list
1038+
[stdlib-types-map]: ./stdlib-types/map
1039+
[stdlib-types-record]: ./stdlib-types/record
1040+
[stdlib-types-set]: ./stdlib-types/set
1041+
[stdlib-types-string]: ./stdlib-types/string
1042+
[stdlib-types-tuple]: ./stdlib-types/tuple
10441043
[syntax-operators]: ./syntax#binary-expressions
10451044
[syntax-page]: ./syntax
10461045
[syntax-precedence]: ./syntax#precedence

0 commit comments

Comments
 (0)