diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 44f6be3..00de5e6 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -59,9 +59,6 @@ jobs: - name: Check for changes id: check_changes run: | - ls - cd docs - ls if [[ -n $(git status --porcelain) ]]; then echo "CHANGES=true" >> "$GITHUB_OUTPUT"; fi diff --git a/_docs/_site/index.html b/_docs/_site/index.html index fd77b08..5fabf16 100644 --- a/_docs/_site/index.html +++ b/_docs/_site/index.html @@ -192,51 +192,51 @@

Usage

The user is free to create its headings, line breaks and make use of all other markdown utilities.
All R code identified by r code markdown blocks will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the code block representation. If you don’t want to evaluate the code at all, use run_examples = FALSE, which is the default.

testscript.rs

-
/// HFft
-/// ## fft
-///
-/// `fft() -> HArray` \
-///
-/// Computes the fast fourier transform of the `HArray`. \
-///
-/// #### Returns
-///
-/// An `HArray`. \
-///
-/// #### Examples
-///
-/// ```r
-/// arr = array(c(1,2,3,4,5,6,7,8,9,10,11,12), c(3,4))
-/// dtype = HDataType$float32
-/// HArray$new_from_values(arr, dtype)
-/// HFft$fft(harray)
-/// ```
-///
-fn fft(harray: &HArray) -> HArray {
-    HArray(harray.0.fft())
-}
+
/// HFft
+/// ## fft
+///
+/// `fft() -> HArray` \
+///
+/// Computes the fast fourier transform of the `HArray`. \
+///
+/// #### Returns
+///
+/// An `HArray`. \
+///
+/// #### Examples
+///
+/// ```r
+/// arr = array(c(1,2,3,4,5,6,7,8,9,10,11,12), c(3,4))
+/// dtype = HDataType$float32
+/// HArray$new_from_values(arr, dtype)
+/// HFft$fft(harray)
+/// ```
+///
+fn fft(harray: &HArray) -> HArray {
+    HArray(harray.0.fft())
+}
 
-/// HFft
-/// ## fft_mut
-///
-/// `fft_mut()` \
-///
-/// Computes the fast fourier transform of the `HArray`. \
-/// The operation is done in-place. \
+/// HFft
+/// ## fft_mut
+///
+/// `fft_mut()` \
+///
+/// Computes the fast fourier transform of the `HArray`. \
+/// The operation is done in-place. \
 
-/// #### Examples
-///
-/// ```r
-/// arr = array(c(1,2,3,4,5,6,7,8,9,10,11,12), c(3,4))
-/// dtype = HDataType$float32
-/// HArray$new_from_values(arr, dtype)
-/// HFft$fft_mut(harray)
-/// ```
-///
-fn fft_mut(harray: &mut HArray) {
-    let inner_mut = harray.get_inner_mut();
-    inner_mut.fft_mut()
-}

+/// #### Examples
+///
+/// ```r
+/// arr = array(c(1,2,3,4,5,6,7,8,9,10,11,12), c(3,4))
+/// dtype = HDataType$float32
+/// HArray$new_from_values(arr, dtype)
+/// HFft$fft_mut(harray)
+/// ```
+///
+fn fft_mut(harray: &mut HArray) {
+    let inner_mut = harray.get_inner_mut();
+    inner_mut.fft_mut()
+}
rdocs::generate_docs("./testscript.R")

The website will be generated on the current working directory.