Skip to content

Commit

Permalink
polish: index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HlisTilen committed Apr 10, 2024
1 parent 051ad64 commit d82822f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ using TCXreader
makedocs(
sitename = "TCXreader",
format = Documenter.HTML(),
modules = [TCXreader]
modules = [TCXreader],
pages = [
"Home" => "index.md",
]
)

17 changes: 15 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ using TCXreader
author, activities = loadTCXFile("path/to/your/file.tcx")
```

## API Reference

```@docs
TCXreader.TCXTrackPoint
```
### `TCXTrackPoint`

- **Description**: Represents a single track point in a TCX file, encapsulating geographical, temporal, and physiological data.
Expand All @@ -36,6 +37,9 @@ author, activities = loadTCXFile("path/to/your/file.tcx")
- `heart_rate_bpm`: Heart rate in BPM (optional).
- `speed`: Speed in m/s (optional).

```@docs
TCXreader.TCXLap
```
### `TCXLap`

- **Description**: Represents a single lap within a TCX file, encapsulating temporal, physiological, and spatial metrics.
Expand All @@ -53,6 +57,9 @@ author, activities = loadTCXFile("path/to/your/file.tcx")
- `triggerMethod`: Trigger method for the lap.
- `avgSpeed`: Average speed (optional).

```@docs
TCXreader.TCXActivity
```
### `TCXActivity`

- **Description**: Represents a single activity within a TCX file, including the sport type, activity ID, laps, and device information.
Expand All @@ -62,6 +69,9 @@ author, activities = loadTCXFile("path/to/your/file.tcx")
- `laps`: Vector of `TCXLap`.
- `device`: Device information (`DeviceInfo`).

```@docs
TCXreader.TCXDeviceInfo
```
### `DeviceInfo`

- **Description**: Represents the device that recorded the TCX activity, including details such as the name, unit ID, product ID, and version.
Expand All @@ -71,6 +81,9 @@ author, activities = loadTCXFile("path/to/your/file.tcx")
- `productId`: Product ID.
- `version`: Device software version.

```@docs
TCXreader.TCXAuthor
```
### `TCXAuthor`

- **Description**: Represents the author of the TCX file, including the name, software build version, language ID, and part number.
Expand Down

0 comments on commit d82822f

Please sign in to comment.