Skip to content

Commit 67beece

Browse files
committed
Put constant docstrings on docs page
1 parent 2a70697 commit 67beece

File tree

3 files changed

+51
-2
lines changed

3 files changed

+51
-2
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ makedocs(;
4141
"Home" => "index.md",
4242
"Utilities" => "api.md",
4343
"Units" => "units.md",
44+
"Constants" => "constants.md",
4445
"Types" => "types.md",
4546
]
4647
)

docs/src/constants.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
# Units
3+
4+
Many common physical constants are available as well:
5+
6+
```@docs
7+
Constants.c
8+
Constants.h
9+
Constants.hbar
10+
Constants.e
11+
Constants.k_B
12+
Constants.N_A
13+
Constants.eV
14+
Constants.R
15+
Constants.F
16+
Constants.sigma_sb
17+
Constants.alpha
18+
Constants.u
19+
Constants.G
20+
Constants.mu_0
21+
Constants.eps_0
22+
Constants.m_e
23+
Constants.m_p
24+
Constants.m_n
25+
Constants.a_0
26+
Constants.k_e
27+
Constants.Ryd
28+
```
29+
30+
## Astronomical constants
31+
32+
```@docs
33+
Constants.M_earth
34+
Constants.M_sun
35+
Constants.M_jup
36+
Constants.R_earth
37+
Constants.R_jup
38+
Constants.R_sun
39+
Constants.L_sun
40+
Constants.L_bol0
41+
Constants.sigma_T
42+
Constants.au
43+
Constants.pc
44+
Constants.ly
45+
Constants.atm
46+
```

docs/src/units.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,16 @@ in a namespace with all the units available.
1616

1717
```@docs
1818
Units.m
19-
Units.g
19+
Units.kg
2020
Units.s
2121
Units.A
2222
Units.K
2323
Units.cd
2424
Units.mol
2525
```
2626

27+
### Derived units
28+
2729
Several derived SI units are available as well:
2830

2931
```@docs
@@ -39,4 +41,4 @@ Units.Ω
3941
Units.T
4042
Units.L
4143
Units.bar
42-
```
44+
```

0 commit comments

Comments
 (0)