Skip to content

Commit

Permalink
Add GH workflow for rustdoc. (#20)
Browse files Browse the repository at this point in the history
* Add GH workflow for rustdoc.

* Fixed text blocks in CLI README.txt
  • Loading branch information
bheylin authored May 23, 2023
1 parent c901c01 commit c131aca
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
14 changes: 13 additions & 1 deletion .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,23 @@ jobs:
with:
arguments: --all-features --workspace

docs:
runs-on: ubuntu-latest
timeout-minutes: 45
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
env:
RUSTDOCFLAGS: -D warnings
- run: cargo doc --workspace --all-features --no-deps --document-private-items

outdated:
runs-on: ubuntu-latest
if: github.event_name != 'pull_request'
timeout-minutes: 45
steps:
- uses: actions/checkout@v3
- uses: dtolnay/install@cargo-outdated
- run: cargo outdated --workspace -R --exit-code 1
- run: cargo outdated --workspace --exit-code 1
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OCPI tariffs

This project provides software for doing calculations with [OCPI][ocpi]
[tariffs][tariffs]. Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf)
This project provides software for doing calculations with [OCPI](https://evroaming.org/ocpi-background/)
[tariffs](https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#1-tariffs-module). Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf)
version.

[![crates-io]](https://crates.io/crates/ocpi-tariffs "Crates.io version")
Expand Down
10 changes: 5 additions & 5 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

# OCPI tariffs CLI

This crate provides a binary for doing calculations with [OCPI][ocpi]
[tariffs][tariffs]. Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf)
This crate provides a binary for doing calculations with [OCPI](https://evroaming.org/ocpi-background/)
[tariffs](https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#1-tariffs-module). Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf)
version.

## Installation

```ignore
```text
cargo install ocpi-tariffs-cli
```

Expand All @@ -21,7 +21,7 @@ The binary can be directly executed using `ocpi-tariffs`. Execute `ocpi-tariffs

To price a tariff and CDR (Charge detail record) and see a breakdown of the separate periods use `analyze`:

```ignore
```text
Analyze a given charge detail record (CDR) against either a provided tariff structure or a tariff that is contained in the CDR itself.
This command will show you a breakdown of all the calculated costs.
Expand Down Expand Up @@ -52,7 +52,7 @@ Options:

To price a tariff and CDR and check if the calculation differs from the original CDR use `validate`:

```ignore
```text
Validate a given charge detail record (CDR) against either a provided tariff structure or a tariff that is contained in the CDR itself.
This command will show the differences between the calculated totals and the totals contained in the provided CDR.
Expand Down

0 comments on commit c131aca

Please sign in to comment.