Skip to content

Commit

Permalink
Add page headers to documentation (#361)
Browse files Browse the repository at this point in the history
  • Loading branch information
sostock authored Jun 20, 2020
1 parent 6fed328 commit 67d61c3
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 3 deletions.
3 changes: 1 addition & 2 deletions docs/src/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
License
=======
# License

```@eval
using Markdown
Expand Down
1 change: 1 addition & 0 deletions docs/src/conversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DocTestSetup = quote
using Unitful
end
```
# Conversion/promotion

## Converting between units

Expand Down
2 changes: 2 additions & 0 deletions docs/src/display.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# How units are displayed

By default, exponents on units or dimensions are indicated using Unicode superscripts on
macOS and without superscripts on other operating systems. You can set the environment
variable `UNITFUL_FANCY_EXPONENTS` to either `true` or `false` to force using or not using
Expand Down
1 change: 1 addition & 0 deletions docs/src/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DocTestSetup = quote
using Unitful
end
```
# Highlighted features

## Dispatch on dimensions

Expand Down
1 change: 1 addition & 0 deletions docs/src/logarithm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DocTestSetup = quote
using Unitful
end
```
# Logarithmic scales

!!! note
Logarithmic scales are new to Unitful and should be considered experimental.
Expand Down
1 change: 1 addition & 0 deletions docs/src/manipulations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DocTestSetup = quote
using Unitful
end
```
# Manipulating units

## Unitful string macro

Expand Down
1 change: 0 additions & 1 deletion docs/src/newunits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ DocTestSetup = quote
using Unitful
end
```

# Defining new units

!!! note
Expand Down
1 change: 1 addition & 0 deletions docs/src/temperature.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ DocTestSetup = quote
using Unitful:AffineError
end
```
# Temperature scales

Temperatures require some care. Temperature scales like `K` and `Ra` are thermodynamic
temperature scales, with zero on the scale corresponding to absolute zero. Unit conversions
Expand Down
2 changes: 2 additions & 0 deletions docs/src/trouble.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ DocTestSetup = quote
using Unitful
end
```
# Troubleshooting

## Why do unit conversions yield rational numbers sometimes?

We use rational numbers in this package to permit exact conversions
Expand Down
2 changes: 2 additions & 0 deletions docs/src/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ DocTestSetup = quote
using Unitful
end
```
# Types

## Overview
We define a [`Unitful.Unit{U,D}`](@ref) type to represent a unit (`U` is a symbol,
like `:Meter`, and `D` keeps track of dimensional information).
Expand Down

0 comments on commit 67d61c3

Please sign in to comment.