Added workflows to generate docs

This commit is contained in:
Uttarayan Mondal
2021-06-02 10:54:14 +05:30
parent e90db39a41
commit cdfac6c3c1
3 changed files with 64 additions and 3 deletions
+39
View File
@@ -0,0 +1,39 @@
name: Documentation
on:
push:
branches: [ master ]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- 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 and push
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git checkout gh-pages
rm -rf docs
cp -r target/doc ./docs
cp index.html docs/
git add docs
git commit --allow-empty -am "Auto Generated Documentation"
git push
+22
View File
@@ -0,0 +1,22 @@
name: Rust Build Test
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose
+3 -3
View File
@@ -1,5 +1,5 @@
use pyo3::prelude::*;
use pyo3::types::IntoPyDict;
use pyo3::{types::PyModule, PyObject, PyResult, Python};
// use pyo3::types::IntoPyDict;
#[derive(Debug)]
pub struct Speech {
pyobject_speech: PyObject,
@@ -27,7 +27,7 @@ impl Speech {
}
/// # Safety
/// The save function is a wrapper around google_speech.Speech.save
/// The save function is a wrapper around google_speech.Speech.save python function
/// which might be unsafe
pub unsafe fn save<S: AsRef<str>>(&self, path: S) -> PyResult<()> {
Python::with_gil(|py| {