Added documentation action
This commit is contained in:
@@ -0,0 +1,37 @@
|
|||||||
|
name: Documentation
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Install latest toolchain
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain:stable
|
||||||
|
default: true
|
||||||
|
override: true
|
||||||
|
- name: Build Docs
|
||||||
|
run: cargo doc --color=always
|
||||||
|
- name: Copy docs
|
||||||
|
run: |
|
||||||
|
mv docs/index.html ./
|
||||||
|
rm -rf docs
|
||||||
|
cp -r target/doc ./docs
|
||||||
|
mv index.html docs/
|
||||||
|
- name: Push changes
|
||||||
|
run: |
|
||||||
|
git config --global user.name 'github-actions[bot]'
|
||||||
|
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
|
||||||
|
git add docs
|
||||||
|
git commit -am "Generated docs from github-actions[bot]"
|
||||||
|
git push
|
||||||
@@ -4,7 +4,7 @@ Documentation of [ntext-rs](https://uttarayan21.github.io/ntext-rs) generated by
|
|||||||
|
|
||||||
A rust library to get numbers (usize) as words
|
A rust library to get numbers (usize) as words
|
||||||
|
|
||||||
`12345 ` -> `twelvethousandthreehundredfortyfive`
|
`12345 ` -> `Twelve Thousand,Three Hundred,Forty-Five`
|
||||||
|
|
||||||
Add to cargo.toml
|
Add to cargo.toml
|
||||||
|
|
||||||
@@ -24,6 +24,6 @@ fn main() {
|
|||||||
```
|
```
|
||||||
|
|
||||||
which should output
|
which should output
|
||||||
`twelvethousandthreehundredfortyfive`
|
`Twelve Thousand,Three Hundred,Forty-Five`
|
||||||
|
|
||||||
Check the [documentation](https://uttarayan21.github.io/ntext-rs) which has more examples and is usually up to date.
|
Check the [documentation](https://uttarayan21.github.io/ntext-rs) which has more examples and is usually up to date.
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
//! Example program with default formatting
|
//! Example program with default formatting
|
||||||
|
//! Source [ntext-rs](https://github.com/uttarayan21/ntext-rs)
|
||||||
//!```rust
|
//!```rust
|
||||||
//!extern crate ntext;
|
//!extern crate ntext;
|
||||||
//!use ntext::to_text;
|
//!use ntext::to_text;
|
||||||
|
|||||||
Reference in New Issue
Block a user