Skip to content

Commit 3159e56

Browse files
Eben60giordanosostock
authored
add dimensions docs to default units docs chapter (#794)
* add dimensions docs to default units docs chapter * replace actual docstring text by @docs * Delete hundreds of useless lines in `docs/src/defaultunits.md` * Add `Unitful` to `docs` environment using `sources` * [CI] Upload docs build as artifact * Switch order of dimension and quantities * Remove leftover section header --------- Co-authored-by: Mosè Giordano <[email protected]> Co-authored-by: Sebastian Stock <[email protected]>
1 parent 3a7ceb5 commit 3159e56

File tree

5 files changed

+94
-676
lines changed

5 files changed

+94
-676
lines changed

.github/workflows/documentation.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,8 @@ jobs:
3636
- uses: julia-actions/julia-docdeploy@v1
3737
env:
3838
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
39+
- uses: actions/upload-artifact@v4
40+
with:
41+
name: documentation-build
42+
path: docs/build
43+
retention-days: 90

docs/Project.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
99
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
1010
tectonic_jll = "d7dd28d6-a5e6-559c-9131-7eb760cdacc5"
1111

12+
[sources]
13+
Unitful = {path = ".."}
14+
1215
[compat]
1316
Documenter = "1"
1417
Latexify = "0.16.9"
18+
Plots = "1"

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ makedocs(
2525
"Latexifying units" => "latexify.md"
2626
"Extending Unitful" => "extending.md"
2727
"Troubleshooting" => "trouble.md"
28-
"Pre-defined units and constants" => "defaultunits.md"
28+
"Pre-defined dimensions, units, and constants" => "defaultunits.md"
2929
"License" => "LICENSE.md"
3030
]
3131
)

0 commit comments

Comments
 (0)